You can call this operation to apply for an internal endpoint for the shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.

This operation is only applicable to sharded cluster instances. For more information, see Apply for endpoints of shard or Configserver nodes.

Note The requested endpoint can only be accessed over the internal network. If you want to access the endpoint through the public network, 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
DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the sharded cluster instance.

NodeId String Yes d-bpxxxxxxxx

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.
Action String No AllocateNodePrivateNetworkAddress

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

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

The name of the account.

Note
  • It must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
  • You must set the account and password only when applying for the endpoint of a shard or Configserver node for the first time. The account and password are required for all shard and Configserver nodes.
  • The permissions of this account are fixed to read-only.
AccountPassword String No Test123456

The password for the account.

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

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
RequestId String EFD65226-08CC-4C4D-B6A4-CB3C382F67B0

The ID of the request.

Samples

Sample requests


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

Sample success responses

XML format

<AllocateNodePrivateNetworkAddressResponse>
	  <RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>
</AllocateNodePrivateNetworkAddressResponse>

JSON format

{
	"RequestId":"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}

Error codes

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