概述
更新时间:2026-07-31
集群生命周期 OpenAPI 的资源路径前缀为:
Text
1/v1/dedicated/cluster
clusterId 是专享版集群唯一标识,例如 tsdb-cl-abc123。调用方应使用集群 ID,而不是可修改的集群名称标识资源。
公共约定
| 项目 | 约定 |
|---|---|
| 请求和响应 | application/json |
| 字段命名 | camelCase |
| 时间格式 | ISO-8601 / RFC3339 字符串 |
| 分页 | pageNo / pageSize 页码分页;pageNo 从 1 开始,pageSize 最大 100 |
| 订单类接口 | 成功提交后返回 orderId,再通过列表或详情查询资源状态 |
| 创建幂等 | 可通过 clientToken query 参数标识创建请求;同一值不得用于不同创建参数 |
写操作需要满足实名认证和主账号要求;子用户不能执行创建、变配、续费、删除、改名、升级、管理员令牌签发或 EIP 变更等写操作。
接口清单
| 能力 | Method | URL | 参考 |
|---|---|---|---|
| 获取创建选项 | GET |
/v1/dedicated/cluster/create-options |
接口说明 |
| 查询子网库存状态 | POST |
/v1/dedicated/cluster/subnet-stock |
接口说明 |
| 创建集群 | POST |
/v1/dedicated/cluster |
接口说明 |
| 查询集群列表 | GET |
/v1/dedicated/cluster |
接口说明 |
| 查询集群详情 | GET |
/v1/dedicated/cluster/{clusterId} |
接口说明 |
| 修改集群名称 | PUT |
/v1/dedicated/cluster/{clusterId}/name |
接口说明 |
| 变配或扩缩容 | PUT |
/v1/dedicated/cluster/{clusterId}/resize |
接口说明 |
| 续费 | POST |
/v1/dedicated/cluster/{clusterId}/renew |
接口说明 |
| 释放(删除)集群 | DELETE |
/v1/dedicated/cluster/{clusterId} |
接口说明 |
| 查询可升级版本 | GET |
/v1/dedicated/cluster/{clusterId}/upgrade/versions |
接口说明 |
| 升级集群 | PUT |
/v1/dedicated/cluster/{clusterId}/upgrade |
接口说明 |
| 查询管理员令牌状态 | GET |
/v1/dedicated/cluster/{clusterId}/admin-token |
接口说明 |
| 获取或重置管理员令牌 | POST |
/v1/dedicated/cluster/{clusterId}/admin-token |
接口说明 |
| 查询操作记录 | GET |
/v1/dedicated/cluster/{clusterId}/operations |
接口说明 |
| 绑定 EIP | PUT |
/v1/dedicated/cluster/{clusterId}/eip |
接口说明 |
| 解绑 EIP | DELETE |
/v1/dedicated/cluster/{clusterId}/eip |
接口说明 |
异步操作
创建、变配、扩缩容、续费和释放等操作是异步操作。接口成功受理只表示请求已经提交,不表示集群已经达到目标状态。调用方应继续查询集群列表、详情或操作记录,直到资源进入目标状态或明确失败。
相同集群存在进行中操作时,新的变更请求可能被拒绝。收到操作冲突错误后,应先读取集群详情和操作记录,不要立即重复提交。
状态枚举
| 字段 | 取值 |
|---|---|
status |
Creating、Running、Resizing、Upgrading、Deleting、Error、Unrecoverable |
progress.stage |
OrderAccepted、ResourcePreparing、NodeDeploying、AccessConfiguring、Ready、Upgrading、Resizing、ScalingOut、ScalingIn、NodeTerminating、AccessTearingDown、BucketCleaning |
adminToken.state |
uninitialized、initialized、unknown |
access.publicAccessStatus |
Unbound、Binding、Bound、Unbinding、Error |
operation.status |
trying、success、failed |
status 表示集群整体状态,progress.stage 表示当前长耗时操作的阶段。自动化程序应同时读取两者,不要根据展示文案或单个 HTTP 成功响应推断操作已经完成。
错误响应
JSON
1{
2 "requestId": "req-20260708100000-abcdef",
3 "code": "<error-code>",
4 "message": "<actionable-message>"
5}
常见错误包括参数非法、权限不足、未实名、资源不存在、操作冲突、超出配额、库存不足、余额不足和订单失败。收到写操作错误时,先保留 requestId 并查询订单和资源状态,再决定是否重试。
不同错误场景的 code 和 HTTP 状态码以实际响应为准。部分 code 不是固定枚举,可能随服务调整。程序应优先根据 HTTP 状态码分类处理,同时保留 code 和 requestId,不要把观察到的所有 code 固化为分支条件,也不要解析可能调整的 message 文案。无法自行定位时,提交工单并提供 requestId。
评价此篇文章
