DescribeDBInstanceNetInfo - 查询实例的所有连接地址信息 - 云数据库 RDS

该接口用于查询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.	-
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。

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

变更历史

变更时间

变更内容概要

操作

2023-06-27

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

看变更集

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

2021-12-28

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

看变更集

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