扩容集群实例的节点数量

接口说明

扩容指定集群实例的节点数量。

约束说明

• 该接口既支持包年包月实例，也支持按需实例。
• 仅支持扩容社区版集群实例的mongos节点和shard节点。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge

请求消息

• 参数说明

  表2 参数说明

  名称	参数类型	是否必选	描述
  type	String	是	待扩容的对象类型。 扩容mongos节点时，取值为“mongos”。 扩容shard组时，取值为“shard”。
  spec_code	String	是	资源规格编码，获取方式请参见查询数据库规格中响应参数“flavors.spec_code”。
  num	String	是	待扩容的mongos节点或shard组数量。一个集群实例下，最多支持32个mongos节点和32个shard组。
  volume	Object	否	磁盘信息。详情请参见表3。 扩容mongos节点时，不传该参数。 扩容shard组时，该参数必选，指定新增的所有shard组的磁盘信息。 说明： 如果一次性添加多个shard组，该shard组只能选择相同的规格和磁盘容量。
  is_auto_pay	Boolean	否	扩容包年包月实例的节点数量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

  表3 volume字段数据结构说明

  名称	参数类型	是否必选	描述
  size	String	是	指定新增的所有shard组的磁盘容量。取值范围：10GB~5000GB。

请求示例

• 扩容mongos节点数量，spec_code为dds.mongodb.c6.medium.4.mongos，数量为1

  { 
  	"type": "mongos",
  	"spec_code":"dds.mongodb.c6.medium.4.mongos",
  	"num": 1
  }

• 扩容shard组数量，spec_code为dds.mongodb.c6.medium.4.mongos，新增shard组的磁盘容量为330GB

  {
  	"type": "shard",
  	"spec_code":"dds.mongodb.c6.medium.4.shard",
  	"num": 1,
          "volume": { 
               "size": 330 
      }
  }

响应消息

• 参数说明

  表4 参数说明

  名称	参数类型	是否必选	描述
  job_id	String	是	任务ID。
  order_id	String	否	订单ID，仅扩容包年包月实例的节点数量时返回该参数。

• 响应示例

  { 
      "job_id": "4008c8914b624785a02ab7966d4d" 
  }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。