调用DescribeDBInstanceNetInfo查询实例的所有连接地址信息

该接口用于查询RDS实例的所有连接地址信息。

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDBInstanceNetInfo	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。	ETnLKlblzczshOTUbOC****
DBInstanceId	string	是	实例ID。可调用DescribeDBInstances获取。	rm-uf6wjk5****
Flag	integer	否	备用参数，无需配置。	test
DBInstanceNetRWSplitType	string	否	连接地址类型，取值： Normal：普通连接地址。 ReadWriteSplitting：读写分离连接地址。说明默认返回所有类型连接地址。	Normal
GeneralGroupName	string	否	专属集群MySQL通用版实例所属的组名。	rgc-2ze****

返回参数

名称	类型	描述	示例值
	object
SecurityIPMode	string	白名单模式，取值： normal：通用模式。 safety：高安全模式。	safety
RequestId	string	请求ID。	777C4593-8053-427B-99E2-105593277CAB
InstanceNetworkType	string	网络类型，取值： Classic：经典网络。 VPC：专有网络。	VPC
DBInstanceNetInfos	object []	实例的连接地址信息列表。
VSwitchId	string	交换机ID。	vsw-uf6adz52c2p****
ConnectionStringType	string	连接地址类型，取值： Normal：普通连接地址。 ReadWriteSplitting：读写分离连接地址。	Normal
ConnectionString	string	连接地址。	rm-uf6w****.mysql.rds.aliyuncs.com
ExpiredTime	string	混访模式下，经典网络的剩余时间，单位：秒。	1209534
Upgradeable	string	IP版本是否能够升级，取值： Enable：可以升级。 Disabled：不可以升级。说明 IPv4版本可以升级到IPv6版本。	Disabled
MaxDelayTime	string	延迟阈值，只在读写分离连接地址返回该参数，单位：秒。说明超过该延迟阈值的只读实例不会被分配流量。	12
IPType	string	网络类型。经典网络类型取值： Inner：内网。 Public：外网。 VPC类型取值： Private：内网。 Public：外网。	Public
Port	string	连接端口。	3306
BabelfishPort	string	Babelfish for RDS PostgreSQL TDS端口号。说明该参数仅适用于RDS PostgreSQL实例，Babelfish for RDS PostgreSQL的更多介绍，请参见Babelfish简介。	1433
VPCId	string	VPC ID。	vpc-uf6f7l4fg90*****
DistributionType	string	读请求分配策略，只在读写分离连接地址返回该参数，取值： Standard：按规格权重自动分配。 Custom：自定义分配权重。	Standard
IPAddress	string	IP地址。	192.168.XX.XX
SecurityIPGroups	object []	实例的IP白名单分组列表。
SecurityIPs	string	白名单IP。	127.0.XX.XX
SecurityIPGroupName	string	IP白名单分组名称。	Default
DBInstanceWeights	object []	实例权重信息列表。说明开通了读写分离连接地址的实例会返回该参数
Availability	string	实例可用状态，取值： Unavailable：不可用。 Available：可用。	Unavailable
Weight	string	实例当前权重。	100
DBInstanceId	string	实例ID。	rm-uf6wjk5****
Role	string	废弃参数。	无
DBInstanceType	string	实例类型，取值： Master：主实例。 Readonly：只读实例。	Master
PGBouncerPort	string	PgBouncer端口号。说明仅当RDS PostgreSQL实例开启了PgBouncer时，返回此参数。	6432

示例

正常返回示例

JSON格式

{
  "SecurityIPMode": "safety",
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB",
  "InstanceNetworkType": "VPC",
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "VSwitchId": "vsw-uf6adz52c2p****",
        "ConnectionStringType": "Normal",
        "ConnectionString": "rm-uf6w****.mysql.rds.aliyuncs.com",
        "ExpiredTime": "1209534",
        "Upgradeable": "Disabled",
        "MaxDelayTime": "12",
        "IPType": "Public",
        "Port": "3306",
        "BabelfishPort": "1433",
        "VPCId": "vpc-uf6f7l4fg90*****",
        "DistributionType": "Standard",
        "IPAddress": "192.168.XX.XX",
        "SecurityIPGroups": {
          "securityIPGroup": [
            {
              "SecurityIPs": "127.0.XX.XX",
              "SecurityIPGroupName": "Default"
            }
          ]
        },
        "DBInstanceWeights": {
          "DBInstanceWeight": [
            {
              "Availability": "Unavailable",
              "Weight": "100",
              "DBInstanceId": "rm-uf6wjk5****",
              "Role": "无",
              "DBInstanceType": "Master"
            }
          ]
        },
        "PGBouncerPort": "6432"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	TimeoutRetryLater	Timeout, retry later.	-
400	InvalidDBInstanceName.NotFound	DB instance name not found.	-
400	IllegalParameter	Illegal parameter	参数不正确。
400	Readins.NotFound	Readonly instance not found.	-

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

变更历史

变更时间

变更内容概要

操作

2023-06-27

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更

2021-12-28

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：400
出参	OpenAPI 返回结构发生变更