管理 API 密钥

ClickHouse Cloud 提供了一个使用 OpenAPI 的 API，允许您以编程方式管理您的帐户和服务的各个方面。

注意

本文档涵盖 ClickHouse Cloud API。有关数据库 API 端点，请参阅 云端点 API

1. 您可以使用左侧菜单上的 API 密钥 选项卡来创建和管理您的 API 密钥。

2. API 密钥 页面最初会显示一个提示，要求您创建您的第一个 API 密钥，如下所示。创建第一个密钥后，您可以使用出现在右上角的 新建 API 密钥 按钮创建新密钥。

3. 要创建 API 密钥，请指定密钥名称、密钥权限和过期时间，然后单击 生成 API 密钥。

注意

权限与 ClickHouse Cloud 预定义角色对齐。开发者角色对分配的服务具有只读权限，而管理员角色具有完全的读写权限。

查询 API 端点

要将 API 密钥与 查询 API 端点一起使用，请将组织角色设置为 Member（最低要求），并授予服务角色对 Query Endpoints 的访问权限。

4. 下一个屏幕将显示您的密钥 ID 和密钥密码。复制这些值并将其放在安全的地方，例如密钥管理库。离开此屏幕后将不再显示这些值。

5. ClickHouse Cloud API 使用 HTTP 基本身份验证来验证 API 密钥的有效性。以下是如何使用您的 API 密钥使用 curl 向 ClickHouse Cloud API 发送请求的示例

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

6. 返回到 API 密钥 页面，您将看到密钥名称、密钥 ID 的最后四个字符、权限、状态、过期日期和创建者。您可以从此屏幕编辑密钥名称、权限和过期时间。密钥也可以从此屏幕禁用或删除。

注意

删除 API 密钥是一个永久操作。任何使用该密钥的服务将立即失去对 ClickHouse Cloud 的访问权限。

端点

有关端点详情，请参阅 API 参考。使用您的 API 密钥和 API 密码以及基本 URL https://api.clickhouse.cloud/v1。