调用DescribeDBClusterNetInfoItems接口查询指定云数据库ClickHouse集群的网络信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterNetInfoItems

系统规定参数。取值:DescribeDBClusterNetInfoItems

DBClusterId String cc-bp1qx68m06981****

集群ID。

返回数据

名称 类型 示例值 描述
NetInfoItems Array of NetInfoItem

网络信息列表。

NetInfoItem
VpcId String vpc-bp175iuvg8nxqraf2****

VPC ID。

说明 连接地址的网络类型为Public时,返回值为空。
VSwitchId String vsw-bp1gzt31twhlo0sa5****

交换机ID。

说明 连接地址的网络类型为Public时,返回值为空。
ConnectionString String cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com

数据库连接地址。

JdbcPort String 3306

JDBC端口号。

NetType String VPC

连接地址的网络类型,取值:

  • Public:公网。
  • VPC:VPC。
HttpPort String 8123

HTTP端口号。

IPAddress String 10.255.234.251

IP地址。

ClusterNetworkType String VPC

网络类型,目前只支持VPC。

RequestId String 9A23C87D-87DF-4DA0-A50E-CB13F4F7923D

请求ID。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusterNetInfoItems
&DBClusterId=cc-bp1qx68m06981****
&公共请求参数

正常返回示例

XML格式

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

<DescribeDBClusterNetInfoItemsResponse>
    <NetInfoItems>
        <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>
        <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>
        <ConnectionString>cc-bp1qx68m06981****.ads.rds.aliyuncs.com</ConnectionString>
        <JdbcPort>3306</JdbcPort>
        <NetType>VPC</NetType>
        <HttpPort>8123</HttpPort>
        <IPAddress>10.255.234.251</IPAddress>
    </NetInfoItems>
    <ClusterNetworkType>VPC</ClusterNetworkType>
    <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>
</DescribeDBClusterNetInfoItemsResponse>

JSON格式

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

{
  "NetInfoItems" : [ {
    "VpcId" : "vpc-bp175iuvg8nxqraf2****",
    "VSwitchId" : "vsw-bp1gzt31twhlo0sa5****",
    "ConnectionString" : "cc-bp1qx68m06981****.ads.rds.aliyuncs.com",
    "JdbcPort" : "3306",
    "NetType" : "VPC",
    "HttpPort" : "8123",
    "IPAddress" : "10.255.234.251"
  } ],
  "ClusterNetworkType" : "VPC",
  "RequestId" : "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D"
}

错误码

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

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