All Products
Search

This Product

    ApsaraDB for MongoDB:CreateNode

    Document Center

    ApsaraDB for MongoDB:CreateNode

    Last Updated:Sep 03, 2024

    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.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • 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 Key: the condition key that is defined by the cloud service.
    • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    dds:CreateNodecreate
    • dbinstance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the sharded cluster instance.

    		dds-bp11501cd7b5****
    NodeClassstringYes

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

    		dds.shard.mid
    NodeStorageintegerNo

    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.
    		10
    NodeTypestringYes

    The type of the node. Valid values:

    • shard: shard node
    • mongos: mongos node
    		shard
    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****
    AutoPaybooleanNo

    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
    ReadonlyReplicasintegerNo

    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
    BusinessInfostringNo

    The business information. This is an additional parameter.

    		{“ActivityId":"000000000"}
    CouponNostringNo

    The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

    		youhuiquan_promotion_option_id_for_blank
    ShardDirectbooleanNo

    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
    AccountNamestringNo

    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
    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.
    • 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 parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		7D48FB19-20CA-4725-A870-3D8F5CE6****
    NodeIdstring

    The node ID.

    		d-bp1b234bf7a4****
    OrderIdstring

    The order ID.

    		20951063702****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-07-08API Description Update. The Error code has changedView Change Details