文档

DescribeClusterNetInfo - 查询网络信息

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeClusterNetInfolist
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

企业版、基础版或湖仓版的集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下集群的详情,包括集群 ID。
amv-wz9dqvn0o7****
Enginestring

数据库引擎,取值:

  • AnalyticDB(默认):AnalyticDB for MySQL 引擎。
  • Clickhouse:宽表引擎。
Clickhouse

返回参数

名称类型描述示例值
object
ClusterNetworkTypestring

集群网络类型,当前仅支持专有网络,取值固定为 VPC

VPC
RequestIdstring

请求 ID。

69A29B65-CD0C-52B1-BE42-8B454569747F
Itemsarray<object>

详情。

object

集群列表。

VSwitchIdstring

交换机 ID。

说明 当 NetType 取值为 Public 时,交换机 ID 返回为空。
vsw-bp1syh8vvw8yec****
ConnectionStringstring

集群的网络连接地址。

  • 当网络类型为 VPC 时,ConnectionString 为 VPC 地址。
  • 当网络类型为 Public 时,ConnectionString 为公网地址。
amv-wz9dqvn0o7****.ads.aliyuncs.com
NetTypestring

网络类型。取值说明:

  • Public:公网。
  • VPC:VPC 网络。
VPC
Portstring

端口号。固定为 3306

3306
VPCIdstring

VPC ID。

说明 当 NetType 取值为 Public 时,VPC ID 返回为空。
vpc-8vbhucmd5b****
IPAddressstring

IP 地址。

  • 当网络类型为 VPC 时,IPAddress 为私网 IP 地址。
  • 当网络类型为 Public 时,IPAddress 为连接数据库的客户端 IP 地址。
192.168.xx.xx
ConnectionStringPrefixstring

网络地址的前缀。

  • 当网络类型为 VPC 时,ConnectionStringPrefix 为 VPC 地址的前辍。
  • 当网络类型为 Public 时,ConnectionStringPrefix 为数据库公网连接地址的前缀。
amv-wz9dqvn0o7****
Portsarray<object>

端口列表。

object

端口详情

Portstring

对外服务端口。

3306
Protocolstring

协议类型。取值:

  • 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错误码错误信息描述
400ACS.InvalidParameter.%sParameter %s is invalid.输入的参数无效
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

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