更新时间:2025-10-14 GMT+08:00
分享

扩容集群实例的节点数量

接口说明

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

约束说明

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

调试

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

URI

  • URI格式

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

  • URI样例

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

表1 路径参数

名称

是否必选

类型

IN

描述

project_id

string

path

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

string

path

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求消息

表2 请求Header参数

名称

是否必选

类型

IN

描述

X-Auth-Token

string

header

参数解释:

从IAM服务获取的用户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,表示手动从账户中支付,默认为该方式。

默认取值:

false。

表4 volume字段数据结构说明

名称

参数类型

是否必选

描述

size

String

参数解释:

指定新增的所有shard组的磁盘容量。

约束限制:

不涉及。

取值范围:

  • shard规格小于8U时:10GB~5000GB。
  • shard规格为8U及以上时,10GB~10000GB。

默认取值:

不涉及。

请求示例

  • 扩容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 
        }
    }

响应消息

  • 参数说明
    表5 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    参数解释:

    任务ID。

    取值范围:

    不涉及。

    order_id

    String

    参数解释:

    订单ID,仅扩容包年包月实例的节点数量时返回该参数。

    取值范围:

    不涉及。

  • 响应示例
    { 
        "job_id": "4008c8914b624785a02ab7966d4d" 
    }

SDK

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

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档