All Products
Search

This Product

    ApsaraDB for MongoDB:CreateNodeBatch

    Document Center

    ApsaraDB for MongoDB:CreateNodeBatch

    Last Updated:Sep 03, 2024

    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.

    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:CreateNodeBatchcreate
    • Instance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
      none
    		none

    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 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****
    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, choose Expenses > Orders. 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.

    Note Up to 32 mongos or shard nodes are supported for each sharded cluster instance.
    		{"Shards":[{"DBInstanceClass":"mdb.shard.4x.large.d","Storage":20}]}
    CouponNostringNo

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

    Change history

    Change timeSummary of changesOperation
    2024-07-08API Description Update. The Error code has changedView Change Details
    2023-10-17The internal configuration of the API is changed, but the call is not affectedView Change Details