文档首页/ 文档数据库服务 DDS/ API参考 (巴黎区域) / API/ 实例管理/ 扩容集群实例的节点数量
更新时间：2022-02-22 GMT+08:00
查看PDF
分享

扩容集群实例的节点数量

功能介绍

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

接口约束

  • 仅支持扩容集群实例的mongos节点和shard节点。
  • 新增节点的规格系列需要和实例已有节点的规格系列一致。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/enlarge

  • 参数说明
    表1 参数说明

    名称

    是否必选

    描述

    project_id

    是

    租户在某一region下的project ID。

    instance_id

    是

    实例ID。

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    描述

    type

    是

    String

    待扩容的对象类型。

    • 扩容mongos节点时，取值为“mongos”。
    • 扩容shard组时，取值为“shard”。

    spec_code

    是

    String

    资源规格编码，获取方式请参见查询所有实例规格信息中响应参数“flavors.spec_code”。

    num

    是

    Integer

    待扩容的mongos节点或shard组数量。

    volume

    否

    Object

    磁盘信息。详情请参见表3。

    • 扩容mongos节点时，不传该参数。
    • 扩容shard组时，该参数必选，指定新增的所有shard组的磁盘信息。
      说明：

      如果一次性添加多个shard组，该shard组只能选择相同的规格和磁盘容量。
    表3 volume字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    size

    是

    Integer

    指定新增的所有shard组的磁盘容量。取值范围：10GB~2000GB。
  • 请求头 
    POST https://DDS的Endpoint/v3/{project_id}/instances/{instance_id}/enlarge
  • 请求体样例
    扩容mongos节点数量： 
    { 
	"type": "mongos",
	"spec_code":"dds.c3.medium.4.mongos",
	"num": 1
}
    扩容shard组数量： 
    {
	"type": "shard",
	"spec_code":"dds.c3.medium.4.shard",
	"num": 1,
        "volume": { 
             "size": 330 
    }
}

响应消息

  • 要素说明
    表4 要素说明

    名称

    参数类型

    描述

    job_id

    String

    任务ID。
  • 响应样例 
    { 
    "job_id": "4008c8914b624785a02ab7966d4d" 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理