文档

DescribeDBInstanceIPArrayList - 查看RDS实例IP白名单

更新时间:

该接口用于查询RDS实例的IP白名单。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceIPArrayListREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
WhitelistNetworkTypestring

白名单的网络类型,取值:

  • Classic:高安全白名单模式下的经典网络
  • VPC:高安全白名单模式下的专有网络
  • MIX:通用白名单模式

默认返回所有网络类型的白名单 IP。

VPC

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

E2B6AF71-DC32-4055-B477-43B348798D10
Itemsobject []

IP 白名单分组列表。

DBInstanceIPArrayAttributestring

白名单分组属性,默认为空。

说明 控制台不显示带有 hidden 属性的分组,带有该标签的分组通常是用于访问 DTS 等服务的。
hidden
DBInstanceIPArrayNamestring

IP 白名单分组名称。

rds_default
SecurityIPTypestring

IP 地址的类型。

IPv4
SecurityIPListstring

IP 白名单分组下的 IP 列表。

192.168.XX.XX/24

示例

正常返回示例

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错误码错误信息描述
400InvalidEndpointType.FormatThe specified EndpointType is invalid.指定的EndpointType无效,请检查参数正确性。
400InvalidParameterInvalid parameter.无效的参数。
400InvalidParameter.OwnerAccountThe specified OwnerAccount is invalid.操作失败,参数OwnerAccount错误,请检查。
400WhitelistNetType.FormatThe specified is WhitelistNetType not valid.-
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

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

  • 本页导读 (1)
文档反馈