DescribeDBClusterNetInfo - 查询集群的网络信息 - 云原生数据仓库AnalyticDB

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBClusterNetInfo	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	am-bp1xxxxxxxx47
RegionId	string	否	集群所在的地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
ClusterNetworkType	string	集群网络类型。	VPC
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	array<object>	集群列表。
Address	object
VSwitchId	string	交换机 ID。说明当 NetType 取值为 Public 时，交换机 ID 返回为空。	vsw-xxxxxx
ConnectionString	string	集群连接地址。	am-bpxxxxxxxx.ads.aliyuncs.com
NetType	string	网络类型。取值说明： Public：公网； VPC：VPC。	VPC
Port	string	集群连接端口。	3306
VPCId	string	VPC ID。说明当 NetType 取值为 Public 时，VPC ID 返回为空。	vpc-xxxxxxxxx
IPAddress	string	IP 地址。	192.168.x.x
ConnectionStringPrefix	string	集群连接地址前缀。	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	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

变更时间	变更内容概要	操作
2024-05-17	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情