管理 API 密钥

ClickHouse Cloud 提供了一个基于 OpenAPI 的 API，允许你以编程方式管理你的账号以及服务的各个方面。

注意

本文档介绍的是 ClickHouse Cloud API。关于数据库 API 端点，请参阅 Cloud Endpoints API

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

2. API Keys 页面初次打开时会显示一个提示，引导你创建第一个 API 密钥，如下所示。创建第一个密钥后，你可以使用右上角出现的 New API Key 按钮创建新的密钥。

3. 要创建一个 API 密钥，指定密钥名称、密钥权限以及过期时间，然后点击 Generate API Key。

注意

权限与 ClickHouse Cloud 的预定义角色保持一致。Developer 角色对分配的服务具有只读权限，而 Admin 角色具有完整的读写权限。

查询 API 端点

要在 Query API Endpoints 中使用 API 密钥，请将 Organization Role 至少设置为 Member，并为 Service Role 授予对 Query Endpoints 的访问权限。

4. 下一屏会显示你的 Key ID 和 Key secret。复制这些值并将其保存在安全的位置，例如密码库。这些值在你离开此页面后将不会再次显示。

5. ClickHouse Cloud API 使用 HTTP Basic Authentication 来验证你的 API 密钥是否有效。下面是一个使用 curl 携带 API 密钥向 ClickHouse Cloud API 发送请求的示例：

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

6. 返回 API Keys 页面后，您将看到密钥名称、Key ID 的后四位字符、权限、状态、到期日期以及创建者。您可以在此界面编辑密钥名称、权限和到期时间，也可以在此界面禁用或删除密钥。

注意

删除 API 密钥是不可恢复的操作。任何使用该密钥的服务都会立即失去对 ClickHouse Cloud 的访问权限。

端点

有关端点的详细信息，请参阅 API 参考。
将您的 API Key 和 API Secret 与基础 URL https://api.clickhouse.cloud/v1 一起使用。