You can call this operation to assign a public IP address to a MongoDB instance.

Debugging

OpenAPI Explorer simplifies API usage. You can use OpenAPI Explorer to perform debugging operations, such as retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Name Type Required Example Description
Action String No AllocatePublicNetworkAddress

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

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Note If you specify this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
NodeId String No s-bpxxxxxxxx

The ID of the Mongos, Shard, or config server in the specified sharded cluster instance.

Note
  • This parameter is only valid when you specify the DBInstanceId parameter to the ID of a sharded cluster instance.
  • You can callDescribeDBInstanceAttribute to query the IDs of Mongos, Shard, and ConfigServer nodes.

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.