ClickHouse Cloud API
概述
ClickHouse Cloud API 是一个 REST API，专为开发者设计，以便轻松管理 ClickHouse Cloud 上的组织和云服务。使用我们的 Cloud API，您可以创建和管理云服务、配置 API 密钥、向您的组织添加或删除成员等等。
了解如何创建您的第一个 API 密钥并开始使用 ClickHouse Cloud API。
Swagger (OpenAPI) 端点和 UI
ClickHouse Cloud API 基于开源 OpenAPI 规范 构建，以便于可预测的客户端使用。如果您需要以编程方式使用 ClickHouse Cloud API 文档，我们通过 https://api.clickhouse.cloud/v1 提供基于 JSON 的 Swagger 端点。您也可以通过 Swagger UI 找到 API 文档。
如果您的组织已迁移到其中一个 新的定价方案，并且您使用 OpenAPI，则需要在云服务创建 POST 请求中删除 tier 字段。
由于我们不再提供云服务层级，因此 tier 字段已从云服务对象中删除。
这将影响 POST、GET 和 PATCH 云服务请求返回的对象。因此，任何使用这些 API 的代码可能需要进行调整以处理这些更改。
速率限制
开发者每个组织限制为 100 个 API 密钥。每个 API 密钥在 10 秒窗口内限制为 10 个请求。如果您想增加组织中每个 10 秒窗口的 API 密钥或请求数量，请联系 [email protected]
Terraform 提供程序
官方 ClickHouse Terraform 提供程序允许您使用 基础设施即代码 创建可预测、版本控制的配置，从而使部署更不易出错。
您可以在 Terraform 注册表 中查看 Terraform 提供程序文档。
如果您想为 ClickHouse Terraform 提供程序贡献代码，您可以在 GitHub 仓库 中查看源代码。
如果您的组织已迁移到其中一个 新的定价方案，您需要使用我们的 ClickHouse Terraform 提供程序 版本 2.0.0 或更高版本。此升级是必需的，以处理云服务 tier 属性的变化，因为在定价迁移后，tier 字段不再被接受，并且应该删除对它的引用。
您现在还可以将 num_replicas 字段指定为云服务资源的一个属性。
Terraform 和 OpenAPI 新定价：副本设置说明
每个云服务将创建的副本数量默认为 Scale 和 Enterprise 层级的 3 个，而 Basic 层级的默认值为 1 个。对于 Scale 和 Enterprise 层级，可以通过在云服务创建请求中传递 numReplicas 字段来调整它。对于仓库中的第一个云服务，numReplicas 字段的值必须在 2 到 20 之间。在现有仓库中创建的云服务，其副本数量可以低至 1 个。
支持
我们建议首先访问 我们的 Slack 频道 以获得快速支持。如果您需要更多帮助或有关我们 API 及其功能的更多信息，请通过 https://console.clickhouse.cloud/support 联系 ClickHouse 支持团队。
