Applies for a public endpoint for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) 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.

DBClusterId String Yes am-bp278jg9****

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

You can call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.

ConnectionStringPrefix String No am-bp278jg9****.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.
  • By default, the cluster name is used as the prefix of the public endpoint.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=AllocateClusterPublicConnection
&DBClusterId=am-bp278jg9****
&ConnectionStringPrefix=am-bp278jg9****.ads.aliyuncs.com
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified value for the DBClusterId parameter does not exist. Check whether the value is valid.

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