更新时间:2026-04-03 GMT+08:00

实例规格变更

功能介绍

实例规格变更。

URI

POST /v2/{engine}/{project_id}/instances/{instance_id}/extend

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

参数解释

消息引擎的类型。支持的类型为rocketmq。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

oper_type

String

参数解释

变更类型。

约束限制

不涉及。

取值范围

  • storage:存储空间扩容,节点数量不变。

  • horizontal:RocketMQ 5.x为实例规格扩容。RocketMQ 4.8.0为代理数扩容。

  • vertical:垂直扩容,broker的底层虚机规格变更,代理数量和存储空间不变,仅RocketMQ 4.8.0支持。

默认取值

不涉及。

new_storage_space

Integer

参数解释

新存储规格

约束限制

当oper_type类型是storage时,该参数有效且必填。

  • 当oper_type类型是storage时,每个broker存储空间最少扩容100GB。

  • 当oper_type类型是horizontal时,每个broker的存储空间不变。

取值范围

不涉及。

默认取值

不涉及。

new_product_id

String

参数解释

新产品ID

约束限制

  • RocketMQ 5.x:当oper_type类型是horizontal时该参数有效且必填,规格变更仅限于集群实例。

  • RocketMQ 4.8.0:当oper_type类型是vertical时该参数有效且必填,规格变更仅限于集群实例。

取值范围

不涉及。

默认取值

不涉及。

new_broker_num

Integer

参数解释

代理数量

约束限制

当oper_type参数为horizontal时,该参数必填。

取值范围

不涉及。

默认取值

不涉及。

publicip_id

String

参数解释

实例绑定的弹性IP地址的ID。以英文逗号隔开多个弹性IP地址的ID。

约束限制

当oper_type参数为horizontal且开启了公网访问时,此参数必填。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

规格变更任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

POST https://{endpoint}/v2/rocketmq/{project_id}/instances/{instance_id}/extend

{
  "oper_type" : "horizontal",
  "new_product_id" : "rocketmq.b2.large.8"
}

响应示例

状态码:200

实例规格变更成功。

{
  "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
}

状态码

状态码

描述

200

实例规格变更成功。

错误码

请参见错误码