Creates a shard or mongos node for 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 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 automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateNode

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

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-bp11501cd7b5****

The ID of the sharded cluster instance.

NodeClass String Yes dds.shard.mid

The instance type of the shard or mongos node. For more information, see Instance types.

NodeStorage Integer No 10

The disk space of the node. Valid values: 10 to 2000. Unit: GB. The value must be a multiple of 10.

Note When the NodeType parameter is set to Shard, you must specify the NodeStorage parameter.
NodeType String Yes shard

The type of the node. Valid values:

  • shard
  • mongos
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. 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: 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.

Note If the billing method is subscription, you must specify this parameter.
ReadonlyReplicas Integer No 5

The number of read-only nodes in the shard node. Valid values: 0 to 5. Default value: 0.

Note This parameter is available only for ApsaraDB for MongoDB instances that are purchased on the China site (
BusinessInfo String No {“ActivityId":"000000000"}

The business information. This is an additional parameter.

CouponNo String No youhuiquan_promotion_option_id_for_blank

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

Response parameters

Parameter Type Example Description
RequestId String 7D48FB19-20CA-4725-A870-3D8F5CE6****

The ID of the request.

NodeId String d-bp1b234bf7a4****

The ID of the node.

OrderId String 20951063702****

The ID of the order.


Sample requests

&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "7D48FB19-20CA-4725-A870-3D8F5CE6****",
  "NodeId" : "d-bp1b234bf7a4****",
  "OrderId" : "20951063702****"

Error codes

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