变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。
接口说明
请确保在使用该接口前,已充分了解云数据库 MongoDB 产品的收费方式和价格。
该接口仅适用于云数据库 MongoDB 分片集群实例。
对多个分片集群实例进行批量升降配操作时,目标规格会受到一定的约束,例如存储空间扩容,目标容量需大于等于当前容量。当多个分片集群实例规格不一致的时候,会随机选择一个分片集群实例的规格去构造约束条件,可能出现无法升降配的情况。 如果遇到无法正常进行批量升降配的情况,建议选择使用 ModifyNodeSpec 接口对单个分片集群实例进行变配。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
dds:ModifyNodeSpecBatch |
update |
*Instance
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID,您可以调用 DescribeRegions 查询。 |
cn-hangzhou |
DBInstanceId |
string |
是 |
需要进行变更配置的实例 ID。 |
dds-bp1337621e8f**** |
NodesInfo |
string |
是 |
需要变配的 Mongos 节点、Shard 节点的规格信息。具体规格请参见实例规格表。 |
{"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd****","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5****","Storage":30}]} |
ClientToken |
string |
否 |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 |
ETnLKlblzczshOTUbOCz**** |
AutoPay |
boolean |
否 |
是否自动付费。取值:
默认值为 true。 |
true |
EffectiveTime |
string |
否 |
变更配置的生效时间,取值:
说明
默认为 Immediately。 |
Immediately |
OrderType |
string |
否 |
变配类型,取值:
说明
当实例付费方式为包年包月时,该参数可用。 |
UPGRADE |
CouponNo |
string |
否 |
是否使用优惠券,取值说明:
|
default |
BusinessInfo |
string |
否 |
业务信息。 |
{“ActivityId":"000000000"} |
TargetVswitchId |
string |
否 |
||
TargetHiddenZoneId |
string |
否 |
||
TargetZoneId |
string |
否 |
||
TargetSecondaryZoneId |
string |
否 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
OrderId |
string |
订单 ID。 |
21012719476**** |
RequestId |
string |
请求 ID。 |
0637BC25-6895-5500-871F-1127CA34**** |
示例
正常返回示例
JSON
格式
{
"OrderId": "21012719476****",
"RequestId": "0637BC25-6895-5500-871F-1127CA34****"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | GadInstanceNotSupport | GAD Instance doesn't support the operation. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。