All Products
Document Center

ApsaraDB for MongoDB:AllocateNodePrivateNetworkAddress

Last Updated:Nov 06, 2023

Applies for an internal endpoint for a shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.

Operation Description

This operation applies only to sharded cluster instances. For more information, see Apply for an endpoint for a shard or Configserver node.

Note The requested endpoint can only be accessed over the internal network. If you want to access the endpoint over the Internet, call the AllocatePublicNetworkAddress operation to apply for a public endpoint.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


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
  • DBInstance

Request parameters


The zone ID of the instance.

Note You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance.

The ID of the sharded cluster instance.


The ID of the shard or Configserver node.

Note You can call the DescribeDBInstanceAttribute operation to query the ID of the shard or Configserver node.

The name of the account.

  • The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
  • You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.
  • The permissions of this account are fixed to read-only.
  • shardcsaccount

    The password of the account.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include !#$%^&*()_+-=
    • The password must be 8 to 32 characters in length.

    Response parameters


    The ID of the request.



    Sample success responses


      "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****"

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidAccountName.ForbidSpecified account name is a keyword.The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.

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

    Change history

    Change timeSummary of changesOperation
    No change history