All Products
Document Center

ApsaraDB for MongoDB:CreateNode

Last Updated:Jan 17, 2023

Adds a shard or mongos node for an ApsaraDB for MongoDB sharded cluster instance.

Operation Description

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

This operation is applicable only to sharded cluster instances.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:CreateNode WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the sharded cluster instance.

NodeClass string Yes

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

NodeStorage integer No

The disk capacity of the node. Unit: GB.

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

Note This parameter is required if the NodeType parameter is set to shard.
NodeType string Yes

The type of the node. Valid values:

  • shard: shard node
  • mongos: mongos node
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. Default value: true. 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, choose Expenses > Orders. On the Orders page, find the order and complete the payment.********
Note This parameter is required when the billing method of the instance is subscription.
ReadonlyReplicas integer No

The number of read-only nodes in the shard node.

Valid values: 0 to 5. The value must be an integer. Default value: 0.

Note This parameter is available only for ApsaraDB for MongoDB instances that are purchased on the China site (
BusinessInfo string No

The business information. This is an additional parameter.

CouponNo string No

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

ShardDirect boolean No

Specifies whether to apply for an endpoint for the shard node. Default value: false. Valid values:

  • true: applies for an endpoint for the shard node.
  • false : does not apply for an endpoint for the shard node.
AccountName string No

The username of the account. The username must meet the following requirements:

  • The username starts with a lowercase letter.
  • The username contains lowercase letters, digits, and underscores (_).
  • The username is 4 to 16 characters in length.
  • Keywords cannot be used as account usernames.
  • The permissions of this account are fixed at read-only.
  • The username and password are required to be set only when you apply for an endpoint for the shard node for the first time.
  • ceshi
    AccountPassword string No

    The password of the account. The password must meet the following requirements:

    • The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters.
    • These special characters include ! @ # $ % ^ & * ( ) _ + - =
    • The password is 8 to 32 characters in length.
    Note The account password of the shard node cannot be reset.

    Response parameters

    Parameter Type Description Example
    RequestId string

    The ID of the request.

    NodeId string

    The ID of the node.

    OrderId string

    The ID of the order.



    Normal return example


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

    Error codes

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