DescribeDBClusterNetInfo - 查询数据库连接地址_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询数据库连接地址信息

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterNetInfo

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 id。	pc-****************
ConnectionStringType	string	否	连接地址类型： Normal：主地址 ReadWriteSplitting：集群地址 MPP: MPP 地址	Normal

返回参数

名称	类型	描述	示例值
	object	集群地址连接信息
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	集群地址连接信息
	object	集群地址连接信息
VSwitchId	string	虚拟交换机 ID。	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	连接地址类型： Normal：主地址 ReadWriteSplitting：集群地址 MPP: MPP 地址	MPP
ConnectionString	string	数据库连接地址。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP 地址的网络类型，返回值： Public：公网。 Inner：经典网络。 Private：VPC 网络。	Public
Port	string	端口号。	1521
VPCId	string	专有网络 ID。	vpc-***************
IPAddress	string	IP 地址。	121...173
ClusterNetworkType	string	集群网络类型，当前仅支持专有网络，取值固定为 VPC。	VPC
RequestId	string	请求 id。	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	节点地址连接信息
	object	节点地址连接信息
NetInfos	object
NetInfo	array<object>	节点地址连接信息
	object	节点地址连接信息
VSwitchId	string	虚拟交换机 ID。	vsw-*************
ConnectionString	string	数据库连接地址。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP 地址的网络类型，返回值： Public：公网。 Inner：经典网络。 Private：VPC 网络。	Public
Port	string	端口号。	5432
VPCId	string	专有网络 ID。	vpc-****************
IPAddress	string	IP 地址。	47...203
DBNodeRole	string	节点角色，取值范围如下： Writer：主节点。 Reader：只读节点。 ColumnReader：列存只读节点。 AI：AI 节点。	Writer
DBInstanceId	string	实例 ID。	pc-*************

示例

正常返回示例

JSON格式

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息，参考变更详情。