All Products
Search

This Product

    ApsaraDB for MongoDB:CreateNode

    Document Center

    ApsaraDB for MongoDB:CreateNode

    Last Updated:May 13, 2026

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

    Operation description

    Before calling this operation, ensure you are familiar with 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 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 Sharded cluster instance types.

    dds.shard.mid
    NodeStorage

    integer

    No

    The storage space of the node. Unit: GB.

    The valid values of this parameter vary based on the storage type of the instance. For more information, see Sharded cluster instance types.

    Note

    This parameter is required when the node type is shard.

    20
    NodeType

    string

    Yes

    The node type. Valid values:

    • shard: A shard node.

    • mongos: A mongos node.

    shard
    ClientToken

    string

    No

    A client-generated token to ensure request idempotence. The token must be unique across requests, contain only ASCII characters, and not exceed 64 characters in length.

    ETnLKlblzczshOTUbOCz****
    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment. Valid values:

    • true: (Default) Enables automatic payment. Ensure that your account has a sufficient balance.

    • false: Disables automatic payment. In this case, you must manually pay for the node. To do so, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose Billing > Billing Management. In the left-side navigation pane, click Order Management. On the Product Orders page, find the order and complete the payment.

    Note

    This parameter is required for subscription instances.

    true
    ReadonlyReplicas

    integer

    No

    The number of read-only nodes in a shard node.

    Valid values: 0 to 5. The default value is 0.

    Note

    This parameter is available only on the China site (aliyun.com).

    5
    BusinessInfo

    string

    No

    Additional business information.

    {“ActivityId":"000000000"}
    CouponNo

    string

    No

    Specifies whether to use a coupon. Valid values:

    • default or null: (Default) An available coupon is automatically applied.

    • youhuiquan_promotion_option_id_for_blank: No coupon is used.

    default
    ShardDirect

    boolean

    No

    Specifies whether to enable a public endpoint for the shard node. Valid values:

    • true: Enables a public endpoint for the shard node.

    • false: (Default) Does not enable a public endpoint for the shard node.

    false
    AccountName

    string

    No

    The account name. The name must meet the following requirements:

    • Starts with a lowercase letter.

    • Consists of lowercase letters, digits, and underscores (_).

    • Is 4 to 16 characters in length.

    Note

    • Keywords of ApsaraDB for MongoDB cannot be used as the account name.

    • The account has read-only permissions.

    • You must set the account name and password only when you enable a public endpoint for a shard node for the first time. These parameters are not required on subsequent requests.

    ceshi
    AccountPassword

    string

    No

    The password for the account. The password must meet the following requirements:

    • Must contain characters from at least three of the following categories: uppercase letters, lowercase letters, digits, and special characters.

    • Special characters include !@#$%^&*()_+-=.

    • Is 8 to 32 characters in length.

    Note

    ApsaraDB for MongoDB does not support resetting the account password for shard nodes.

    123+abc

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    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.