All Products
Search
Document Center

ApsaraDB for MongoDB:CreateNodeBatch

Last Updated:May 11, 2023

Adds mongos or shard nodes for ApsaraDB for MongoDB sharded cluster instances in batches.

Operation Description

Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation.

This operation applies only to sharded cluster instances.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCz****
FromAppstringNo

The source of the request. Valid values:

  • OpenApi: ApsaraDB for MongoDB API.
  • mongo_buy: ApsaraDB for MongoDB console.
OpenApi
AutoPaybooleanNo

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. In this case, you must manually pay for the instance. 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. On the page that appears, select Orders from the left-side navigation pane. On the Orders page, find the order and complete the payment.
true
DBInstanceIdstringYes

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

dds-bp18b0934e70****
NodesInfostringYes

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

NoteUp to 32 mongos or shard nodes are supported for each sharded cluster instance.
{"DBInstanceId":"dds-1ud73a59b6fa****","NodesInfo":"{\"Shards\":[{\"DBInstanceClass\":\"dds.shard.mid\",\"Storage\":10}]}"}
CouponNostringNo

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

youhuiquan_promotion_option_id_for_blank
BusinessInfostringNo

The business information.

{“ActivityId":"000000000"}
ShardDirectbooleanNo

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.
false
AccountNamestringNo

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.
Note
  • Keywords cannot be used as accounts for ApsaraDB for MongoDB.

  • Only the read-only permissions are available for the account.

  • The username and password need to be set if you apply for an endpoint for the shard node for the first time.

ceshi
AccountPasswordstringNo

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 special characters.
  • Special characters include ! @ # $ % ^ & * ( ) _ + - =
  • The password of the account must be 8 to 32 characters in length.
NoteIf you apply for an endpoint for a shard node, the password cannot be changed.
123+abc

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

55D41A94-1ACE-55E8-8BC7-67D622E7****
OrderIdstring

The ID of the order.

50179021707****
NodeIdstring

The ID of the added mongos or shard node.

d-bp18f7d6b6a7****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.