该接口用于查询RDS实例的所有连接地址信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDBInstanceNetInfo | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 | ETnLKlblzczshOTUbOC**** |
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
Flag | integer | 否 | 备用参数,无需配置。 | test |
DBInstanceNetRWSplitType | string | 否 | 连接地址类型,取值:
说明
默认返回所有类型连接地址。
| Normal |
GeneralGroupName | string | 否 | 专属集群MySQL通用版实例所属的组名。 | rgc-2ze**** |
返回参数
示例
正常返回示例
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 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2021-12-28 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|