使用DescribeDBClusterNetInfoItems查询集群网络信息-云数据库 ClickHouse-阿里云

查询指定云数据库ClickHouse集群的网络信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:DescribeDBClusterNetInfoItems

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	cc-bp1qx68m06981****

返回参数

名称	类型	描述	示例值
	object
NetInfoItems	object
NetInfoItem	array<object>	网络信息列表。
	object	网络信息列表。
VpcId	string	VPC ID。说明连接地址的网络类型为 Public 时，返回值为空。	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	交换机 ID。说明连接地址的网络类型为 Public 时，返回值为空。	vsw-bp1gzt31twhlo0sa5****
ConnectionString	string	数据库连接地址。	cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
JdbcPort	string	JDBC 端口号。	3306
NetType	string	连接地址的网络类型，取值： Public：公网。 VPC：VPC。	VPC
HttpPort	string	HTTP 端口号。	8123
IPAddress	string	IP 地址。	10.255.234.251
HttpsPort	string	HTTPS 端口号。	8443
MySQLPort	string	MySQL 端口号。	9004
ClusterNetworkType	string	网络类型，目前只支持 VPC。	VPC
RequestId	string	请求 ID。	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
EnableSLB	boolean	VPC 中是否开启了 SLB。取值说明： true：开启。 false：不开启。	true

示例

正常返回示例

JSON格式

{
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "ConnectionString": "cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com",
        "JdbcPort": "3306",
        "NetType": "VPC",
        "HttpPort": "8123",
        "IPAddress": "10.255.234.251",
        "HttpsPort": "8443",
        "MySQLPort": "9004"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "EnableSLB": true
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

更多信息，参考变更详情。