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

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AllocateNodePrivateNetworkAddress

The operation that you want to perform. Set the value to AllocateNodePrivateNetworkAddress.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

ZoneId String No cn-hangzhou-b

The zone ID of the instance.

Note You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance.
DBInstanceId String Yes dds-bp1fa5efaa93****

The ID of the sharded cluster instance.

NodeId String Yes d-bp124beeb0ac****

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.
AccountName String No shardcsaccount

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.
AccountPassword String No Test123456

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

Parameter Type Example Description
RequestId String 60EEBD77-227C-5B39-86EA-D89163C5****

The ID of the request.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=AllocateNodePrivateNetworkAddress
&DBInstanceId=dds-bp1fa5efaa93****
&NodeId=d-bp124beeb0ac****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateNodePrivateNetworkAddressResponse>
    <RequestId>60EEBD77-227C-5B39-86EA-D89163C5****</RequestId>
</AllocateNodePrivateNetworkAddressResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.