通过 OpenAPI 对 MongoDB ClickPipes 进行扩缩容

大多数用户都不需要使用此 API

DB ClickPipes 的默认配置开箱即用即可处理大多数工作负载。如果您认为当前工作负载需要扩容，请提交支持工单，我们将指导您为该使用场景选择最佳设置。

在以下情况下，扩缩容 API 可能会很有用：

大规模初始加载 (超过 4 TB)
尽可能快地迁移中等规模的数据
在同一服务下支持超过 8 个 CDC ClickPipes

在尝试扩容之前，请先考虑：

确保源 DB 具备足够的可用容量
检查可能导致 CDC 延迟的同步时间间隔和拉取批次大小设置

扩大规模会按比例增加您的 ClickPipes 计算成本。 如果您扩容只是为了完成初始加载，那么在快照完成后务必及时缩容，以避免产生意外费用。有关定价的更多信息，请参阅 ClickPipes 定价。

此流程的前提条件

在开始之前，您需要准备：

ClickHouse API 密钥，并且在目标 ClickHouse Cloud 服务上具有 Admin 权限。
该服务中此前已预配过一个 DB ClickPipe (Postgres、MySQL 或 MongoDB) 。CDC 基础设施会随第一个 ClickPipe 一起创建，并且从那时起扩缩容端点即可用。

如何扩缩容 DB ClickPipes

执行任何命令前，请先设置以下环境变量：

ORG_ID=<Your ClickHouse organization ID>
SERVICE_ID=<Your ClickHouse service ID>
KEY_ID=<Your ClickHouse key ID>
KEY_SECRET=<Your ClickHouse key secret>

查看当前的扩缩容配置 (可选) ：

curl --silent --user $KEY_ID:$KEY_SECRET \
https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
| jq

# example result:
{
  "result": {
    "replicaCpuMillicores": 2000,
    "replicaMemoryGb": 8
  },
  "requestId": "04310d9e-1126-4c03-9b05-2aa884dbecb7",
  "status": 200
}

设置所需的扩缩容规格。支持的配置包括 1–24 个 CPU 核心，内存 (GB) 为核心数的 4 倍：

cat <<EOF | tee cdc_scaling.json
{
  "replicaCpuMillicores": 24000,
  "replicaMemoryGb": 96
}
EOF

curl --silent --user $KEY_ID:$KEY_SECRET \
-X PATCH -H "Content-Type: application/json" \
https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
-d @cdc_scaling.json | jq

等待配置下发并生效 (通常需要 3–5 分钟) 。扩缩容完成后，GET 端点将反映更新后的值：

curl --silent --user $KEY_ID:$KEY_SECRET \
https://api.clickhouse.cloud/v1/organizations/$ORG_ID/services/$SERVICE_ID/clickpipesCdcScaling \
| jq

# example result:
{
  "result": {
    "replicaCpuMillicores": 24000,
    "replicaMemoryGb": 96
  },
  "requestId": "5a76d642-d29f-45af-a857-8c4d4b947bf0",
  "status": 200
}

此流程的前提条件​

如何扩缩容 DB ClickPipes​

此流程的前提条件

如何扩缩容 DB ClickPipes