Changes the configurations of one or more mongos nodes or shard nodes of an ApsaraDB for MongoDB sharded cluster instance.

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for MongoDB. For more information, go to the Pricing tab of the ApsaraDB for MongoDB product page at the international site (

This operation is applicable only to sharded cluster instances.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyNodeSpecBatch

The operation that you want to perform. Set the value to ModifyNodeSpecBatch.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the region ID of the instance.

DBInstanceId String Yes dds-bp1337621e8f****

The ID of the instance whose configurations you want to change.

NodesInfo String Yes null

The configuration information of the mongos nodes or shard nodes whose configurations you want to change. For more information, see Instance types.

ClientToken String No ETnLKlblzczshOTUbOCz****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

AutoPay Boolean No true

Specifies whether to enable automatic payment for the instance. Valid values:

  • true: enables automatic payment. Make sure that your account balance is sufficient.
  • false: disables automatic payment. You can perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, click Expenses to go to the Billing Management console. In the left-side navigation pane, click Orders. On the Orders page, find the order and complete the payment.

Default value: true.

EffectiveTime String No Immediately

The time when the changed configurations take effect. Valid values:

  • Immediately: The configurations immediately take effect.
  • MaintainTime: The configurations take effect during the maintenance window of the instance.

    Default value: Immediately.

OrderType String No UPGRADE

The type of configuration changes. Valid values:

    Note This parameter can be configured only when the billing method of the instance is subscription.
CouponNo String No youhuiquan_promotion_option_id_for_blank

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

BusinessInfo String No {“ActivityId":"000000000"}

The business information.

Response parameters

Parameter Type Example Description
OrderId String 21012719476****

The ID of the order.

RequestId String 0637BC25-6895-5500-871F-1127CA34****

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "0637BC25-6895-5500-871F-1127CA34****",
  "OrderId" : "21012719476****"

Error codes

For a list of error codes, visit the API Error Center.