创建集群
更新时间:2026-07-24
本页覆盖获取创建选项、查询子网库存状态和创建集群接口。公共约定、状态枚举和错误响应见集群生命周期 OpenAPI。
获取创建选项
获取指定地域当前可用于创建 TSDB 专享版集群的地域、可用区、计算规格、节点数和预付费周期等选项。
Http
1GET /v1/dedicated/cluster/create-options?region=bj
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
region |
string | 否 | 地域标识。省略时使用当前服务地域。 |
响应示例
JSON
1{
2 "regions": [{"value": "bj"}],
3 "zones": [{"value": "cn-bj-a", "region": "bj"}],
4 "specs": [
5 {
6 "specCode": "tsdb.c8m32",
7 "cpu": 8,
8 "memoryGb": 32,
9 "tier": "standard",
10 "sellable": true
11 }
12 ],
13 "minNodeCount": 2,
14 "maxNodeCount": 32,
15 "prepaidMonths": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12],
16 "autoRenewSupported": true
17}
创建集群前应以本接口返回的可售选项为准,不要在客户端写死地域、规格、节点数或购买周期。
示例中的地域、可用区、规格和周期仅用于说明响应结构。服务可售范围可能调整,自动化程序应在每次创建或变配前读取当前响应。
查询子网库存状态
按地域、规格、节点数和可用区查询创建集群所需的资源库存状态。
Http
1POST /v1/dedicated/cluster/subnet-stock
2Content-Type: application/json
请求体
JSON
1{
2 "region": "bj",
3 "nodeCount": 3,
4 "specCode": "tsdb.c8m32",
5 "zoneNames": ["cn-bj-a", "cn-bj-b", "cn-bj-c"]
6}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
region |
string | 是 | 地域标识。 |
nodeCount |
number | 是 | 节点数,必须大于 0。 |
specCode |
string | 是 | 计算规格标识。 |
zoneNames |
array | 是 | 1~3 个可用区。 |
响应示例
JSON
1{
2 "items": [
3 {
4 "zoneName": "cn-bj-a",
5 "stockStatus": "Available",
6 "stockAvailable": true,
7 "message": "库存充足"
8 }
9 ]
10}
stockStatus 取值为 Available、Insufficient 或 Unknown。库存状态可能变化,查询成功不保证后续创建一定成功。
创建集群
创建一个预付费 TSDB 专享版集群。该操作要求完成实名认证,并使用主账号身份调用。
Http
1POST /v1/dedicated/cluster?clientToken=<幂等标识>
2Content-Type: application/json
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
clientToken |
string | 否 | 请求幂等标识。同一标识只能用于相同创建参数。 |
请求体
JSON
1{
2 "clusterName": "prod-tsdb",
3 "region": "bj",
4 "vpcId": "vpc-abc123",
5 "subnets": [
6 {"zoneName": "cn-bj-a", "subnetId": "sbn-a"},
7 {"zoneName": "cn-bj-b", "subnetId": "sbn-b"},
8 {"zoneName": "cn-bj-c", "subnetId": "sbn-c"}
9 ],
10 "nodeCount": 3,
11 "specCode": "tsdb.c8m32",
12 "billing": {
13 "paymentTiming": "Prepaid",
14 "reservationLength": 1,
15 "reservationTimeUnit": "month",
16 "autoRenew": false
17 }
18}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
clusterName |
string | 是 | 集群名称,长度 1~64,仅支持 ASCII 字母、数字、-、_,且至少包含一个字母;名称不作为资源唯一标识。 |
region |
string | 是 | 地域标识,当前支持 bj(北京)和 gz(广州)。 |
vpcId |
string | 是 | VPC ID。 |
subnets |
array | 是 | 1~3 个子网及其可用区。 |
subnets[].zoneName |
string | 是 | 可用区。 |
subnets[].subnetId |
string | 是 | 子网 ID。 |
eipId |
string | 否 | 创建时绑定的用户自有 EIP。 |
nodeCount |
number | 是 | 节点数。 |
specCode |
string | 是 | 计算规格标识。 |
billing.paymentTiming |
string | 是 | 当前固定为 Prepaid。 |
billing.reservationLength |
number | 是 | 购买时长。 |
billing.reservationTimeUnit |
string | 是 | month 或 year。 |
billing.autoRenew |
boolean | 否 | 是否自动续费。 |
couponName |
string | 否 | 优惠券名称。 |
响应示例
JSON
1{"orderId": "order-abc123"}
返回 orderId 表示创建订单已经提交。请继续查询集群列表或详情中的 status 和 progress,直到集群进入 Running 状态。若进入 Error,系统仍可能继续处理;若进入 Unrecoverable,表示系统已确认集群无法恢复,请提交工单并提供 requestId 和 orderId。对超时或未知结果的创建请求,应先查询资源状态,再使用原 clientToken 重试相同请求。创建请求的常见错误(参数非法、库存不足、余额不足、配额超限等)及错误响应结构见集群生命周期 OpenAPI的「错误响应」。
评价此篇文章
