文档

DescribeDBClusterNetInfo - 查询集群的网络信息

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

集群 ID。

am-bp1xxxxxxxx47
RegionIdstring

集群所在的地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
ClusterNetworkTypestring

集群网络类型。

VPC
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Itemsobject []

集群列表。

VSwitchIdstring

交换机 ID。

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

集群连接地址。

am-bpxxxxxxxx.ads.aliyuncs.com
NetTypestring

网络类型。取值说明:

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

集群连接端口。

3306
VPCIdstring

VPC ID。

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

IP 地址。

192.168.x.x
ConnectionStringPrefixstring

集群连接地址前缀。

am-bpxxxxxxxx89k51380

示例

正常返回示例

JSON格式

{
  "ClusterNetworkType": "VPC",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "Address": [
      {
        "VSwitchId": "vsw-xxxxxx",
        "ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
        "NetType": "VPC",
        "Port": "3306",
        "VPCId": "vpc-xxxxxxxxx",
        "IPAddress": "192.168.x.x",
        "ConnectionStringPrefix": "am-bpxxxxxxxx89k51380"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:RegionId