Use DescribeEndpoints to query cluster endpoints - ApsaraDB for ClickHouse

To retrieve the cluster endpoints, call DescribeEndpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeEndpoints

none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
DBInstanceId	string	Yes	The cluster ID.	cc-xxxxx
ComputingGroupId	string	No	The computing group ID.	cc-*****-clickhouse

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	xxx-xxx-xxx
Data	object	The response data.
InstanceNetworkType	string	The network type of the instance. Valid values: VPC PUBLIC: Internet.	VPC
Endpoints	array<object>	The endpoints.
	array<object>	The details of an endpoint.
NetType	string	The network type of the endpoint. Valid values: VPC PUBLIC: Internet.	VPC
Status	string	The status of the endpoint.	active
ConnectionString	string	The instance connection string.	cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com
VpcId	string	The VPC ID.	vpc-uf61z****
VSwitchId	string	The vSwitch ID.	vsw-0xi8829****
VpcInstanceId	string	The VPC instance ID.	vpc-uf61z****
Ports	array<object>	The ports.
	object	The details of a port.
Protocol	string	The protocol type. Valid values: HttpPort: HTTP port. HttpsPort: HTTPS port. TcpPort: TCP port.	HttpPort
Port	integer	The port number. The value varies based on the protocol type. For example: HttpPort: 8123 HttpsPort: 8443 TcpPort: 9000	8123
IPAddress	string	The IP address.	172.30.XX.XX
ComputingGroupId	string	The computing group ID.	cc-ad321**-clickhouse
EndpointName	string	The endpoint name.	cc-*****-clickhouse

Examples

Success response

JSON format

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "InstanceNetworkType": "VPC",
    "Endpoints": [
      {
        "NetType": "VPC",
        "Status": "active",
        "ConnectionString": "cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com",
        "VpcId": "vpc-uf61z****",
        "VSwitchId": "vsw-0xi8829****",
        "VpcInstanceId": "vpc-uf61z****",
        "Ports": [
          {
            "Protocol": "HttpPort",
            "Port": 8123
          }
        ],
        "IPAddress": "172.30.XX.XX",
        "ComputingGroupId": "cc-ad321**-clickhouse",
        "EndpointName": "cc-*****-clickhouse"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	The passed instance ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.