调用DescribeClusterNetInfo查询网络信息_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用DescribeDBClusterNetInfo接口查询指定集群的网络信息。

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	企业版、基础版或湖仓版的集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下集群的详情，包括集群 ID。	amv-wz9dqvn0o7****
Engine	string	否	数据库引擎，取值： AnalyticDB（默认）：AnalyticDB for MySQL 引擎。 Clickhouse：宽表引擎。	Clickhouse

返回参数

名称	类型	描述	示例值
	object
ClusterNetworkType	string	集群网络类型，当前仅支持专有网络，取值固定为 VPC。	VPC
RequestId	string	请求 ID。	69A29B65-CD0C-52B1-BE42-8B454569747F
Items	array<object>	详情。
Address	object	集群列表。
VSwitchId	string	交换机 ID。说明当 NetType 取值为 Public 时，交换机 ID 返回为空。	vsw-bp1syh8vvw8yec****
ConnectionString	string	集群的网络连接地址。当网络类型为 VPC 时，ConnectionString 为 VPC 地址。当网络类型为 Public 时，ConnectionString 为公网地址。	amv-wz9dqvn0o7****.ads.aliyuncs.com
NetType	string	网络类型。取值说明： Public：公网。 VPC：VPC 网络。	VPC
Port	string	端口号。固定为 3306。	3306
VPCId	string	VPC ID。说明当 NetType 取值为 Public 时，VPC ID 返回为空。	vpc-8vbhucmd5b****
IPAddress	string	IP 地址。当网络类型为 VPC 时，IPAddress 为私网 IP 地址。当网络类型为 Public 时，IPAddress 为连接数据库的客户端 IP 地址。	192.168.xx.xx
ConnectionStringPrefix	string	网络地址的前缀。当网络类型为 VPC 时，ConnectionStringPrefix 为 VPC 地址的前辍。当网络类型为 Public 时，ConnectionStringPrefix 为数据库公网连接地址的前缀。	amv-wz9dqvn0o7****
Ports	array<object>	端口列表。
ports	object	端口详情
Port	string	对外服务端口。	3306
Protocol	string	协议类型。取值： tcp：传输控制协议。 http：超文本传输协议。 https：超文本传输安全协议。 mysql：MySQL 协议。	mysql

示例

正常返回示例

JSON格式

{
  "ClusterNetworkType": "VPC",
  "RequestId": "69A29B65-CD0C-52B1-BE42-8B454569747F",
  "Items": {
    "Address": [
      {
        "VSwitchId": "vsw-bp1syh8vvw8yec****",
        "ConnectionString": "amv-wz9dqvn0o7****.ads.aliyuncs.com",
        "NetType": "VPC",
        "Port": 3306,
        "VPCId": "vpc-8vbhucmd5b****",
        "IPAddress": "192.168.xx.xx",
        "ConnectionStringPrefix": "amv-wz9dqvn0o7****",
        "Ports": {
          "ports": [
            {
              "Port": 3306,
              "Protocol": "mysql"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ACS.InvalidParameter.%s	Parameter %s is invalid.	输入的参数无效
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

变更时间	变更内容概要	操作
2024-06-13	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情