管理 API Key - ClickHouse Documentation

ClickHouse Cloud 提供基于 OpenAPI 的 API，便于您以编程方式管理账户及服务的各个方面。

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

打开 API Keys 页面

您可以使用左侧菜单中的 API Keys 选项卡创建和管理 API Key。

开始创建 API Key

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

配置 API Key

指定密钥名称、密钥权限和过期时间。

权限与 ClickHouse Cloud 的预定义角色一致。developer 角色对已分配的服务具有只读权限，admin 角色具有完整的读写权限。

查询 API 端点要将 API Key 用于 Query API Endpoints，请将 Organization Role 设置为 Member (最低要求) ，并为 Service Role 授予 Query Endpoints 的访问权限。

添加允许的 IP 地址

要限制哪些客户端可以使用该 API Key，请在 Allow access to this API Key 部分中选择 Specific locations。输入一个 IP 地址或 CIDR 范围，例如 203.0.113.1 或 203.0.113.0/24，并根据需要添加更多条目。查询 API 端点遵循 API Key 级别的 IP 允许列表。由于请求是从 ClickHouse 基础设施内部代理的，因此服务级别的 IP 允许列表不适用。详情请参阅 IP Access Control。完成密钥配置后，点击 Generate API Key。

保存 API Key 凭据

下一个界面将显示您的 Key ID 和 Key secret。请复制这些值并妥善保存在安全的位置，例如密钥保管库。离开此界面后，这些值将不会再次显示。

对 API 请求进行身份验证

ClickHouse Cloud API 使用 HTTP 基本身份验证来验证您的 API Key 是否有效。以下示例展示了如何使用 API Key 通过 curl 向 ClickHouse Cloud API 发送请求：

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

管理现有 API Key

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

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

端点

有关端点的详细信息，请参阅 API 参考文档。请使用您的 API Key 和 API Secret，base URL 为 https://api.clickhouse.cloud/v1。

​端点

端点