该接口用于查询RDS实例的IP白名单。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBInstanceIPArrayList | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
| WhitelistNetworkType | string | 否 | 白名单的网络类型，取值：
默认返回所有网络类型的白名单IP。 | VPC |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E2B6AF71-DC32-4055-B477-43B348798D10",
"Items": {
"DBInstanceIPArray": [
{
"DBInstanceIPArrayAttribute": "hidden",
"DBInstanceIPArrayName": "rds_default",
"SecurityIPType": "IPv4",
"SecurityIPList": "192.168.XX.XX/24"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidEndpointType.Format | The specified EndpointType is invalid. | 指定的EndpointType无效，请检查参数正确性。 |
| 400 | InvalidParameter | Invalid parameter. | 无效的参数。 |
| 400 | InvalidParameter.OwnerAccount | The specified OwnerAccount is invalid. | 操作失败，参数OwnerAccount错误，请检查。 |
| 400 | WhitelistNetType.Format | The specified is WhitelistNetType not valid. | - |
| 403 | IncorrectDBInstanceCharacterType | Current DB Instance character_type does not support this operation. | 当前DB实例字符类型不支持此操作。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
访问错误中心查看更多错误码。