ClickHouse Cloud API 是一个面向开发者的 REST API，旨在让您轻松管理 ClickHouse Cloud 上的组织和服务。通过我们的 Cloud API，您可以创建和管理服务、配置 API 密钥，以及在组织中添加或移除成员等。
了解如何创建您的第一个 API 密钥，并开始使用 ClickHouse Cloud API。
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 的代码都可能需要进行相应调整，以适配这些变更。 如果您的组织已迁移到某个新定价方案，则必须使用 2.0.0 或更高版本的 ClickHouse Terraform 提供商。必须进行此升级，是因为需要处理服务资源中 tier 属性的变更：完成定价迁移后，将不再接受 tier 字段，因此应移除对它的引用。现在，您还可以将 num_replicas 字段指定为服务资源的一个属性。
- 在 plan 和 apply 时，显示
Beta Resource Warning。Terraform 不会因 Warning 而失败，因此运行会正常继续。
- 在其文档中，会有“此资源处于 beta 阶段”的提示框。
Beta 表示 schema 和行为可能会在未来的提供商版本中发生变化。未带此标记的资源均为 GA，并享有常规的兼容性保证。
在 v3.25.2 之前，提供商将这些资源标记为 alpha 而非 beta，且 plan 阶段的 Warning 为 Alpha Resource。仅措辞发生了变化——不涉及 schema、行为或状态迁移——但通过 grep 在 plan 输出中查找 Alpha Resource 的工具将悄然不再匹配。更早的发行版还发布过单独的 alpha 构建。
-alphaN 后缀的版本 (例如 3.15.0-alpha3) 早于单一构建模型。它们仍然可用，但不再构建。
当某项功能达到正式可用状态后，其资源会在下一个提供商发行版中移除 Beta 标记：plan 时 Warning 不再显示，文档中的提示框也会被移除。其他方面均不会改变——无需修改配置、状态迁移，也无需在不同构建之间切换。
每个服务在创建时的默认副本数，在 Scale 和 Enterprise 层级中为 3，而在基础版中为 1。
对于 Scale 和 Enterprise 层级，可以通过在服务创建请求中传入 numReplicas 字段来调整副本数。
对于仓库中的第一个服务，numReplicas 字段的值必须在 2 到 20 之间。在现有仓库中创建的服务，副本数则最低可为 1。
我们建议您先访问我们的 Slack 频道，以获得快速支持。如果
您需要更多帮助，或想进一步了解我们的 API 及其功能，
请通过 https://console.clickhouse.cloud/support 联系 ClickHouse 支持团队 
