本页覆盖修改集群名称、变配或扩缩容、续费、查询可升级版本、升级集群和释放集群接口。公共约定、状态枚举和错误响应见集群生命周期 OpenAPI。

修改集群名称

修改指定集群的用户可见名称。该操作要求使用主账号身份调用。

1PUT /v1/dedicated/cluster/{clusterId}/name
2Content-Type: application/json

Path 参数

请求体

1{"clusterName": "prod-tsdb-new"}

响应示例

1{
2  "clusterId": "tsdb-cl-abc123",
3  "clusterName": "prod-tsdb-new"
4}

集群 ID 不随名称变化。自动化程序应始终使用 clusterId 标识资源。

变配或扩缩容集群

修改集群节点数量或计算规格。该操作要求使用主账号身份调用。

1PUT /v1/dedicated/cluster/{clusterId}/resize
2Content-Type: application/json

Path 参数

请求体

每次请求只能提供 nodeCount 或 specCode 中的一项。

扩缩容示例：

1{"nodeCount": 6}

变更规格示例：

1{"specCode": "tsdb.c16m64"}

响应示例

1{"orderId": "order-abc123"}

返回订单 ID 只表示变更已提交。请继续查询集群详情和操作记录，直到变更成功或失败。

目标节点数和规格应从当前地域的创建选项接口返回值中选择。一次请求不能同时调整节点数和规格；如需同时调整，应等待前一次变更完成、集群恢复 Running 后再提交下一次。变更过程中集群进入 Resizing，具体阶段可从 progress.stage 查看。

续费集群

延长预付费集群的服务期限。该操作要求使用主账号身份调用。

1POST /v1/dedicated/cluster/{clusterId}/renew
2Content-Type: application/json

Path 参数

请求体

1{
2  "reservationLength": 1,
3  "reservationTimeUnit": "month"
4}

响应示例

1{"orderId": "order-abc123"}

返回订单 ID 只表示续费订单已经提交。续费结果和新的到期时间应通过订单结果和集群详情确认。

可选续费周期以创建选项接口当前返回的预付费周期为准，实际价格和订单结果以调用时的计费系统为准。不要根据历史价格或本地缓存推算应付金额。

查询可升级版本

查询指定集群当前可升级的目标版本及其升级提示。

1GET /v1/dedicated/cluster/{clusterId}/upgrade/versions

Path 参数

响应示例

1{
2  "versions": [
3    {
4      "version": "3.1.1",
5      "releasedAt": "2026-07-01T00:00:00Z",
6      "recommended": true,
7      "description": "修复查询稳定性问题。",
8      "releaseNotes": ["优化高并发查询下的内存回收策略。"],
9      "impact": "滚动升级，节点会依次进入升级中，建议业务低峰期发起。"
10    }
11  ]
12}

升级请求中的 targetVersion 必须来自本接口当前返回的版本列表。发起升级前请阅读 impact 并评估业务影响。

versions 只包含高于集群当前版本且允许升级的目标版本，无可升级版本时返回空数组。版本号、版本说明和影响提示均以接口当前响应为准；本接口不返回兼容版本或预计升级时长。

升级集群

将集群升级到可升级版本接口返回的目标版本。该操作要求使用主账号身份调用。

1PUT /v1/dedicated/cluster/{clusterId}/upgrade
2Content-Type: application/json

Path 参数

请求体

1{
2  "targetVersion": "3.1.1",
3  "confirmImmediate": true
4}

响应示例

1{
2  "clusterId": "tsdb-cl-abc123",
3  "targetVersion": "3.1.1",
4  "status": "Upgrading"
5}

升级是异步操作。请通过集群详情和操作记录持续查看进度，不要在升级进行中重复提交升级或其他冲突操作。

当前接口只支持确认后立即滚动升级，不提供定时升级、维护窗口、自动升级、取消预约或预计完成时间。升级影响以可升级版本接口返回的 impact 为准；接口成功只表示系统已经受理升级请求，最终结果以集群状态、升级进度和节点版本为准。

删除集群

释放指定 TSDB 专享版集群。删除会使集群及其中数据不可继续访问，调用前必须确认资源和业务影响。该操作要求使用主账号身份调用。

1DELETE /v1/dedicated/cluster/{clusterId}

Path 参数

响应示例

1{
2  "clusterId": "tsdb-cl-abc123",
3  "status": "Deleting",
4  "orderId": "order-abc123"
5}

删除是异步受理，orderId 可能为空。释放进度以集群列表或详情中的状态为准。请求超时或返回未知结果时，先查询集群是否仍然存在，不要盲目重复删除。

集群从详情和列表中消失后，表示资源释放流程已经完成。删除不可撤销，且该接口不提供数据恢复能力。退款和创建中订单的终结结果不会通过本接口返回，请以订单中心显示的实际处理结果为准。