All Products
Document Center

ApsaraDB for MongoDB:ModifyNodeSpecBatch

Last Updated:Jan 17, 2023

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

Operation Description

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter Type Required Description Example
RegionId string No

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

DBInstanceId string Yes

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

NodesInfo string Yes

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

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

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

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.

  • You can call the ModifyDBInstanceMaintainTime operation to modify the maintenance window of an instance.
  • Default value: **Immediately**.
    OrderType string No

    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

    The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

    BusinessInfo string No

    The business information.


    Response parameters

    Parameter Type Description Example
    OrderId string

    The ID of the order.

    RequestId string

    The ID of the request.



    Normal return example


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

    Error codes

    For a list of error codes, visit the API error center.