CreateNode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

Operation description

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

This operation applies 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:CreateNode

create

*dbinstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the sharded cluster instance.	dds-bp11501cd7b5****
NodeClass	string	Yes	The instance type of the shard or mongos node. For more information, see Instance types.	dds.shard.mid
NodeStorage	integer	No	The disk capacity of the node. Unit: GB. Valid values: 10 to 2000. The value must be a multiple of 10. Note This parameter is required only when the NodeType parameter is set to shard.	20
NodeType	string	Yes	The type of the node. Valid values: shard: shard node mongos: mongos node	shard
ClientToken	string	No	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****
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true (default): 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 that you want to pay for and complete the payment. Note This parameter is required only when the billing method of the instance is subscription.	true
ReadonlyReplicas	integer	No	The number of read-only nodes in the shard node. Valid values: 0, 1, 2, 3, 4, and 5. Default value: 0. Note This parameter is available only for ApsaraDB for MongoDB instances that are purchased on the China site (aliyun.com).	5
BusinessInfo	string	No	The business information. This is an additional parameter.	{“ActivityId":"000000000"}
CouponNo	string	No	The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.	default
ShardDirect	boolean	No	Specifies whether to apply for an endpoint for the shard node. Valid values: true: applies for an endpoint for the shard node. false (default): 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 can contain lowercase letters, digits, and underscores (_). The username must be 4 to 16 characters in length. Note Keywords cannot be used as accounts. This account is granted the read-only permissions. The username and password need to be set if 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 special characters. These special characters include ! @ # $ % ^ & * ( ) _ + - = The password is 8 to 32 characters in length. Note ApsaraDB for MongoDB does not allow you to reset the password of an account.	123+abc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7D48FB19-20CA-4725-A870-3D8F5CE6****
NodeId	string	The node ID.	d-bp1b234bf7a4****
OrderId	string	The order ID.	20951063702****

Examples

Success response

JSON format

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

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.