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

管理 API 密钥

注意

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

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

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

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

注意

权限与 ClickHouse Cloud 预定义角色 一致。 开发人员角色具有只读权限，管理员角色具有完全的读写权限。

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 密钥与基本 URL https://api.clickhouse.cloud/v1 一起使用。