All Products
Search

This Product

    ApsaraDB for MongoDB:AllocateNodePrivateNetworkAddress

    Document Center

    ApsaraDB for MongoDB:AllocateNodePrivateNetworkAddress

    Last Updated:Jan 17, 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.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:AllocateNodePrivateNetworkAddress WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    ZoneId string No

    The zone ID of the instance.

    Note You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance.
    		cn-hangzhou-b
    DBInstanceId string Yes

    The ID of the sharded cluster instance.

    		 dds-bp1fa5efaa93****
    NodeId string Yes

    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.
    		d-bp124beeb0ac****
    AccountName string No

    The name of the account.

    Note
  • 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
    AccountPassword string No

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

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 60EEBD77-227C-5B39-86EA-D89163C5****

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    400 InvalidAccountName.Forbid Specified account name is a keyword.

    For a list of error codes, visit the API error center.