Creates a public endpoint for an ApsaraDB for ClickHouse cluster.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | No | AllocateClusterPublicConnection |
The operation that you want to perform. The operation that you want to perform. Set the value to AllocateClusterPublicConnection. |
| DBClusterId | String | Yes | cc-bp108z124a8o7**** |
The ID of the cluster. |
| ConnectionStringPrefix | String | Yes | cc-bp108z124a8o7**** |
The prefix of the endpoint that is used to connect to the cluster. Set the value to the ID of the cluster. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC |
The ID of the request. |
Examples
Sample requests
http(s)://clickhouse.aliyuncs.com/?Action=AllocateClusterPublicConnection
&DBClusterId=cc-bp108z124a8o7****
&ConnectionStringPrefix=cc-bp108z124a8o7****
&<Common request parameters>Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<AllocateClusterPublicConnectionResponse>
<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</AllocateClusterPublicConnectionResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}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 the cluster ID is valid. |
For a list of error codes, visit the API Error Center.