CreateNodeBatch - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Batch adds mongos or shard nodes for a 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:CreateNodeBatch

create

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
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 ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz****
FromApp	string	No	The source of the request. Valid values: OpenApi: ApsaraDB for MongoDB API mongo_buy: ApsaraDB for MongoDB console	OpenApi
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. 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, choose Expenses > Orders. On the Orders page, find the order and complete the payment.	true
DBInstanceId	string	Yes	The ID of the instance for which you want to add nodes.	dds-bp18b0934e70****
NodesInfo	string	Yes	The specifications of the mongos or shard node that you want to add. For more information, see Instance types. Note Up to 32 mongos or shard nodes are supported for each sharded cluster instance.	{"Shards":[{"DBInstanceClass":"mdb.shard.4x.large.d","Storage":20}]}
CouponNo	string	No	Specifies whether to use coupons. Default value: null. Valid values: default or null: uses coupons. youhuiquan_promotion_option_id_for_blank: does not use coupons.	default
BusinessInfo	string	No	The business information.	{“ActivityId":"000000000"}
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.	false
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. Note 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.	PassWord123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	55D41A94-1ACE-55E8-8BC7-67D622E7****
OrderId	string	The ID of the order.	50179021707****
NodeId	string	The ID of the added mongos or shard node.	d-bp18f7d6b6a7****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	SSLNotSupportAddNode	Instance with SSL certificate can't add node, please contact us to solve this problem.	SSL encryption instances do not allow nodes to be added. If you need to, contact us to solve the problem.
400	ErrorInsufficientResource	There is not enough resource for your operation, requestId: %s.	There is not enough resource for your operation, requestId: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.