文档首页/ 分布式消息服务RabbitMQ版/ API参考 (阿布扎比区域)/ API V2（推荐）/ 规格变更管理/ 新规格实例的规格变更
更新时间：2024-10-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新规格实例的规格变更

功能介绍

实例规格变更。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

engine

是

String

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

缺省值：rabbitmq

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

oper_type

是

String

变更类型。

取值范围：

storage：存储空间扩容，代理数量不变。

horizontal：代理数量扩容，每个broker的存储空间不变。

vertical：垂直扩容，broker的底层虚机规格变更，代理数量和存储空间不变。

new_storage_space

否

Integer

扩容后的存储空间。

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

实例存储空间 = 代理数量 * 每个broker的存储空间。

当oper_type类型是storage时，代理数量不变，每个broker存储空间最少扩容100GB。

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

new_product_id

否

String

规格，例如c6.8u16g.cluster，当oper_type类型是vertical时，该参数才有效且必填。

new_broker_num

否

Integer

当oper_type参数为horizontal时，该参数有效。

new_spec_code

否

String

老规格，例如dms.instance.rabbitmq.cluster.c3.8u16g，当oper_type类型horizontal时，为dms.instance.rabbitmq.cluster.c3.8u16g.5，最后的数字5为代理数

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

规格变更任务ID。

请求示例

  • 扩容存储空间（老规格按需实例）。new_spec_code的值为原规格参数。

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

{
  "new_storage_space" : 600,
  "oper_type" : "storage",
  "new_spec_code" : "dms.instance.rabbitmq.cluster.c3.2u4g.3"
}

  • 扩容代理数量（老规格按需实例）。new_storage_space填原存储大小，new_spec_code的值dms.instance.rabbitmq.cluster.c3.2u4g.5，最后数字5为代理个数。

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

{
  "new_storage_space" : 600,
  "oper_type" : "horizontal",
  "new_spec_code" : "dms.instance.rabbitmq.cluster.c3.2u4g.5"
}

  • 扩容代理规格（老规格按需实例）。new_spec_code需要改成对应规格，例如2u4g改成4u8g。

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

{
  "new_storage_space" : 600,
  "oper_type" : "vertical",
  "new_spec_code" : "dms.instance.rabbitmq.cluster.c3.2u4g.5"
}

  • 扩容存储空间（按需实例）。

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

{
  "new_storage_space" : 600,
  "oper_type" : "storage"
}

  • 扩容代理数量（按需实例）。

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

{
  "oper_type" : "horizontal",
  "new_storage_space" : 500,
  "new_broker_num" : 5
}

  • 扩容代理规格（按需实例）。

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

{
  "oper_type" : "vertical",
  "new_product_id" : "c6.4u8g.cluster"
}

响应示例

状态码： 200

实例规格变更成功。

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

状态码

状态码

描述

200

实例规格变更成功。

错误码

请参见错误码。

父主题： 规格变更管理