文档

DescribeDBInstanceIPArrayList - 查看实例IP白名单

更新时间:

查询允许访问AnalyticDB PostgreSQL版实例的IP白名单。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

该参数已废弃,无需传入该参数。

null
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp***************
DBInstanceIPArrayNamestring

需要查询的 IP 白名单分组的名称。

说明 如果不传入该参数,默认返回所有 IP 白名单分组。
Default

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CB7AA0BF-BE41-480E-A3DC-C97BF85A391B
Itemsarray<object>

实例的 IP 白名单分组列表。

object

实例详情列表。

DBInstanceIPArrayNamestring

IP 白名单分组的名字。

Default
SecurityIPListstring

IP 白名单分组下的 IP 列表,最多 1000 个以逗号隔开,有以下三种格式:

  • 0.0.0.0/0
  • 10.23.12.24(IP)
  • 10.23.12.24/24(CIDR 模式,无类域间路由,/24表示了地址中前缀的长度,范围为[1,32]
127.0.0.1
DBInstanceIPArrayAttributestring

默认为空。用以区分不同的属性值,控制台不显示带有hidden属性的分组。

hidden

示例

正常返回示例

JSON格式

{
  "RequestId": "CB7AA0BF-BE41-480E-A3DC-C97BF85A391B",
  "Items": {
    "DBInstanceIPArray": [
      {
        "DBInstanceIPArrayName": "Default",
        "SecurityIPList": "127.0.0.1",
        "DBInstanceIPArrayAttribute": "hidden"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-20OpenAPI 入参发生变更查看变更详情