文档

DescribeClusterNetInfo - 查询网络信息

更新时间:

调用DescribeDBClusterNetInfo接口查询指定AnalyticDB MySQL湖仓版(3.0)集群的网络信息。

接口说明

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

调试

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

授权信息

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

请求参数

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

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 湖仓版(3.0)集群的详情,包括集群 ID。
amv-wz9dqvn0o7****

返回参数

名称类型描述示例值
object
ClusterNetworkTypestring

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

VPC
RequestIdstring

请求 ID。

69A29B65-CD0C-52B1-BE42-8B454569747F
Itemsobject []

详情。

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****

示例

正常返回示例

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈