ModifyNodeSpecBatch批量修改分片集群节点规格-云数据库 MongoDB 版-阿里云

变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。

接口说明

请确保在使用该接口前，已充分了解云数据库 MongoDB 产品的收费方式和价格。

该接口仅适用于云数据库 MongoDB 分片集群实例。

对多个分片集群实例进行批量升降配操作时，目标规格会受到一定的约束，例如存储空间扩容，目标容量需大于等于当前容量。当多个分片集群实例规格不一致的时候，会随机选择一个分片集群实例的规格去构造约束条件，可能出现无法升降配的情况。如果遇到无法正常进行批量升降配的情况，建议选择使用 ModifyNodeSpec 接口对单个分片集群实例进行变配。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:ModifyNodeSpecBatch

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
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：自动付费，请确保账号有足够的余额。 false：控制台手动付费。您可以登录云数据库 MongoDB 控制台，在页面右上角选择费用 > 费用与成本，在左侧导航栏，选择订购订单>我的订单，在商品订单页签找到目标订单进行支付。默认值为 true。	true
EffectiveTime	string	否	变更配置的生效时间，取值： Immediately：立即生效。 MaintainTime：在实例的可维护时间段内生效。说明您可以调用接口 ModifyDBInstanceMaintainTime 修改实例的可维护时间段。您可以调用接口 DescribeDBInstanceAttribute 查看实例可维护时间段时间。默认为 Immediately。	Immediately
OrderType	string	否	变配类型，取值： UPGRADE：升级配置。 DOWNGRADE：降级配置。说明当实例付费方式为包年包月时，该参数可用。	UPGRADE
CouponNo	string	否	是否使用优惠券，取值说明： default 或 null（默认）：使用优惠券。 youhuiquan_promotion_option_id_for_blank：不使用优惠券。	default
BusinessInfo	string	否	业务信息。	{“ActivityId":"000000000"}
TargetVswitchId	string	否	迁移可用区同时变配的目标虚拟交换机 ID。重要只支持云盘实例。说明只有在迁移可用区同时变配才需要传入此参数	vsw-xxxxxxxx
TargetHiddenZoneId	string	否	迁移可用区同时变配时，隐藏节点（Hidden 节点）的目标可用区。重要只支持云盘实例。重要该参数取值不能与 TargetZoneId 和 TargetSecondaryZoneId 参数值相同。说明只有在迁移可用区同时变配才需要传入此参数	cn-hangzhou-e
TargetZoneId	string	否	迁移可用区同时变配时，主节点（Primary 节点）的目标可用区。重要只支持云盘实例。重要该参数取值不能与 TargetSecondaryZoneId 和 TargetHiddenZoneId 参数值相同。说明只有在迁移可用区同时变配才需要传入此参数	cn-hangzhou-h
TargetSecondaryZoneId	string	否	迁移可用区同时变配时，从节点（Secondary 节点）的目标可用区。重要只支持云盘实例。重要该参数取值不能与 TargetZoneId 和 TargetHiddenZoneId 参数值相同。说明只有在迁移可用区同时变配才需要传入此参数	cn-hangzhou-j

返回参数

名称	类型	描述	示例值
	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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。