You can call this operation to assign a public endpoint to an ApsaraDB for MongoDB instance.

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 AllocatePublicNetworkAddress

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

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of an instance.

Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
RegionId String No cn-hangzhou

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

NodeId String No s-bpxxxxxxxx

A sharded cluster instance consists of three components: mongos, shard, and Configserver.

Note
  • This parameter is valid only if you set theDBInstanceId parameter to the ID of a sharded cluster instance.
  • You can call the DescribeDBInstanceAttribute operation to query the ID of the mongos, shard, or Configserver node.

Response parameters

Parameter Type Example Description
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2270A

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<AllocatePublicNetworkAddressResponse>
      <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
</AllocatePublicNetworkAddressResponse>

JSON format

{
    "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2270A"
}

Error codes

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