跳到主要内容

API 密钥管理

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

API 密钥管理

注意

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

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

    ClickHouse Cloud API Keys Tab

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

    Initial API Screen

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

    Create API Key

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

    API Key ID and Key Secret

  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
  1. 返回到“**API 密钥**”页面，您将看到密钥名称、密钥 ID 的最后四个字符、权限、状态、过期日期和创建者。您可以从此屏幕编辑密钥名称、权限和过期时间。也可以从此屏幕禁用或删除密钥。
注意

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

API Key Management

端点​

端点文档在这里。使用您的 API 密钥和 API 密码以及基本 URL https://api.clickhouse.cloud/v1。