管理 API 密钥
ClickHouse Cloud 提供了一个利用 OpenAPI 的 API,允许您以编程方式管理您的帐户和服务的各个方面。
备注
本文档涵盖 ClickHouse Cloud API。有关数据库 API 端点,请参见 Cloud Endpoints API。
- 您可以使用左侧菜单中的 API Keys 标签来创建和管理您的 API 密钥。

- API Keys 页面最初会显示创建您的第一个 API 密钥的提示,如下所示。在创建第一个密钥后,您可以使用出现在右上角的
New API Key
按钮创建新密钥。

- 要创建 API 密钥,请指定密钥名称、密钥权限和过期时间,然后点击
Generate API Key
。
备注
权限与 ClickHouse Cloud 的 预定义角色 对齐。开发者角色对分配的服务具有只读权限,而管理员角色则具有完全的读写权限。

- 下一屏幕将显示您的密钥 ID 和密钥密钥。复制这些值并将它们放在一个安全的地方,例如保险库。离开此屏幕后,值将不再显示。

- ClickHouse Cloud API 使用 HTTP Basic Authentication 来验证您的 API 密钥的有效性。以下是如何使用 API 密钥通过
curl
向 ClickHouse Cloud API 发送请求的示例:
- 返回 API Keys 页面,您将看到密钥名称、密钥 ID 的最后四个字符、权限、状态、过期日期和创建者。您可以从此屏幕编辑密钥名称、权限和过期时间。密钥也可以从此屏幕禁用或删除。
备注
删除 API 密钥是一个永久性操作。任何使用该密钥的服务将立即失去对 ClickHouse Cloud 的访问权限。

端点
有关端点的详细信息,请参阅 API reference。
使用您的 API Key 和 API Secret,以及基础 URL https://api.clickhouse.cloud/v1
。