跳转到主内容
跳转到主内容

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 个请求。如需为您的组织提升 API 密钥数量上限或每个 10 秒时间窗口内的请求上限，请联系 [email protected]。

Terraform provider​

官方 ClickHouse Terraform Provider 允许你使用 Infrastructure as Code 来创建可预测、可版本控制的配置，从而大幅降低部署过程中的出错风险。

你可以在 Terraform registry 中查看 Terraform provider 的文档。

如果你希望为 ClickHouse Terraform Provider 做出贡献，可以在 GitHub 仓库中查看源代码。

注意

如果你的组织已迁移到某个新定价方案，则需要使用我们的 ClickHouse Terraform provider 2.0.0 或更高版本。此升级是为了处理服务中 tier 属性的变更，因为在定价迁移后，将不再接受 tier 字段，并且应移除对该字段的所有引用。

你现在还可以将 num_replicas 字段指定为 service 资源的一个属性。

Terraform 提供商 的发布​

ClickHouse 维护两个官方 Terraform 提供商：用于云基础设施的 ClickHouse Cloud 提供商，以及用于数据库级对象的 DBops 提供商。两者采用相同的发布模型。

稳定版与 Alpha​

稳定版本 (例如 3.11.1、1.9.0) 仅包含 GA 功能所需的资源。Alpha 版本 (例如 3.12.0-alpha2、1.10.0-alpha1) 除包含稳定版中的全部内容外，还包含仍处于 Beta 或私有预览阶段的功能所需资源，并且必须显式固定到该版本才能使用。

版本管理​

两个提供商都使用语义化版本 (MAJOR.MINOR.PATCH) 。主版本号在发生破坏性变更时递增，次版本号用于引入新功能或新资源，补丁版本号则用于错误修复。Alpha 版本会在下一个次版本号后附加预发布后缀 (例如 3.12.0-alpha1) ；在晋升为稳定版之前，如果又加入了新的修复或变更，alpha 编号也会随之递增 (例如 alpha1 → alpha2 → alpha3) 。发布是按需进行的，而不是遵循固定计划。当某项尚未达到 GA 的功能新增了资源，或某项修复需要提前验证时，就会创建新的 alpha 版本。当累计的变更 (包括其间已达到 GA 的功能) 准备好用于生产环境时，通常会在经过一段时间的客户反馈后创建新的稳定版本。在最终整合为单个稳定版本之前，可能会先积累多个 alpha 次版本。

从 alpha 升级为稳定版本​

当某个 Terraform 功能准备好进入 GA 时，相应的 Terraform 资源会在下一个稳定版本发布时从 alpha 升级为稳定版本。在此之前，该资源仅在 alpha 构建版本中可用。

Terraform 和 OpenAPI 新定价：副本设置详解​

在 Scale 和 Enterprise 层级中，每个服务在创建时的副本数默认是 3，而在 Basic 层级中默认是 1。 对于 Scale 和 Enterprise 层级，可以在服务创建请求中通过指定 numReplicas 字段来进行调整。 对于某个仓库中的第一个服务，numReplicas 字段的取值必须在 2 到 20 之间。而在现有仓库中创建的服务，其副本数量可以低至 1。

支持​

我们建议您优先通过我们的 Slack 频道获取快速支持。 如果您需要更多帮助，或想进一步了解我们的 API 及其功能， 请联系 ClickHouse 支持团队：https://console.clickhouse.cloud/support