DescribeEndpoints - 查询集群访问地址_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

调用DescribeEndpoints接口查询集群的访问地址。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeEndpoints	none	EnterpriseDBCluster acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-beijing
DBInstanceId	string	是	集群 ID。	cc-xxxxx

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	xxx-xxx-xxx
Data	object	返回结果。
InstanceNetworkType	string	实例的网络类型，取值： VPC：专有网络。 PUBLIC：公网网络。	VPC
Endpoints	array<object>	Endpoint 详细信息列表。
Endpoint	object	Endpoint 详细信息。
NetType	string	连接地址的网络类型，取值： VPC：专有网络。 PUBLIC：公网网络。	VPC
Status	string	状态。	active
ConnectionString	string	实例连接地址	cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com
VpcId	string	VPC ID。	vpc-uf61z****
VSwitchId	string	交换机 ID。	vsw-0xi8829****
VpcInstanceId	string	VPC 实例 ID。	vpc-uf61z****
Ports	array<object>	端口详细信息列表。
Port	object	端口详细信息。
Protocol	string	协议类型。取值范围： HttpPort：HTTP 端口号。 HttpsPort：HTTPS 端口号。 TcpPort：TCP 端口号。	HttpPort
Port	integer	访问端口。取值范围： HttpPort：8123 HttpsPort：8443 TcpPort：9000	8123
IPAddress	string	IP 地址。	172.30.XX.XX

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-13	OpenAPI 错误码发生变更	查看变更详情