You can call this operation to apply for a public endpoint for an AnalyticDB for MySQL cluster.

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 AllocateClusterPublicConnection

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

ConnectionStringPrefix String Yes am-bpxxxxxxxxxx.ads.aliyuncs.com

The prefix of the public endpoint.

  • The prefix must contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter.
  • The prefix can be up to 30 characters in length.
  • The cluster name is used by default.
DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=AllocateClusterPublicConnection
&ConnectionStringPrefix=am-bpxxxxxxxxxx.ads.aliyuncs.com
&DBClusterId=am-bp1xxxxxxxx47
&<Common request parameters>

Sample success responses

XML format

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>

JSON format

{
    "RequestId":"1AD222E9-E606-4A42-BF6D-8A4442913CEF"
    }

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether you specify the cluster ID value correctly.

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