Batch adds mongos or shard nodes for an ApsaraDB for MongoDB sharded cluster instance.

Before you call this operation, make sure that you fully understand the billing methods and pricing.

This operation applies 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 dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateNodeBatch

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

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.

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.

FromApp String No OpenApi

The source of the request. Valid values:

  • OpenApi: the ApsaraDB for MongoDB API
  • mongo_buy: the ApsaraDB for MongoDB console
AutoPay Boolean No true

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

  • true: enables automatic payment. Make sure that you have sufficient balance within your account.
  • 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.

DBInstanceId String Yes dds-bp18b0934e70****

The ID of the instance for which you want to add nodes.

NodesInfo String Yes null

The configurations of the mongos or shard nodes that you want to add. For more information, see Instance types.

Note You can add a maximum of 32 mongos or shard nodes for each ApsaraDB for MongoDB sharded cluster instance. If you need more than 32 mongos or shard nodes in a sharded cluster instance,submit a ticket.
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
RequestId String 55D41A94-1ACE-55E8-8BC7-67D622E7****

The ID of the request.

OrderId String 50179021707****

The ID of the order.

NodeId String d-bp18f7d6b6a7****

The ID of the added mongos or shard node.


Sample requests

&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "55D41A94-1ACE-55E8-8BC7-67D622E7****",
  "OrderId" : "50179021707****",
  "NodeId" : "d-bp18f7d6b6a7****"

Error codes

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