文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 实例管理/ 扩容集群实例的节点数量
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

扩容集群实例的节点数量

接口说明

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

约束说明

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

    规格系列包括：通用型（s6）、增强型（c3）、增强Ⅱ型（c6）。

    示例：
    • dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.medium.4.mongos是同一规格系列。
    • dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.mongos不是同一规格系列。

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。
表3 参数说明

名称

参数类型

是否必选

描述

type

String

是

待扩容的对象类型。

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

spec_code

String

是

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

num

String

是

待扩容的mongos节点或shard组数量。一个集群实例下，最多支持32个mongos节点和32个shard组。

volume

Object

否

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

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

    如果一次性添加多个shard组，该shard组只能选择相同的规格和磁盘容量。

is_auto_pay

Boolean

否

扩容包年包月实例的节点数量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

  • true，表示自动从账户中支付。
  • false，表示手动从账户中支付，默认为该方式。

availability_zone_id

String

否

可用区ID。参见查询所有实例规格信息接口中返回的az_status ，在新增mongos节点的时候，可以选择在指定可用区新增。

取值：非空，请参见地区和终端节点。
表4 volume字段数据结构说明

名称

参数类型

是否必选

描述

size

String

是

指定新增的所有shard组的磁盘容量。取值范围：规格小于8U时： 10GB~5000GB，规格为8U及以上时， 10GB~10000GB。
  • 请求示例
    扩容mongos节点数量： 
    { 
	"type": "mongos",
	"spec_code":"dds.mongodb.c6.medium.4.mongos",
	"num": 1
}
    扩容mongos节点数量，带az参数： 
    { 
  "type" : "mongos", 
  "spec_code" : "dds.c3.medium.4.mongos", 
  "num" : 1, 
  "availability_zone_id" : "cn-southwest-288a" 
}
    扩容shard组数量： 
    {
	"type": "shard",
	"spec_code":"dds.mongodb.c6.medium.4.shard",
	"num": 1,
        "volume": { 
             "size": 330 
    }
}

响应参数

  • 参数说明
    表5 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    是

    任务ID。

    order_id

    String

    否

    订单ID，仅扩容包年包月实例的节点数量时返回该参数。
  • 响应示例 
    { 
    "job_id": "4008c8914b624785a02ab7966d4d" 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理