Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.

Description

You can call this operation to query the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBInstanceIPArrayList

The operation that you want to perform. Set the value to DescribeDBInstanceIPArrayList.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see View basic information of a resource group.

DBInstanceId String Yes gp-bp***************

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.

Response parameters

Parameter Type Example Description
RequestId String CB7AA0BF-BE41-480E-A3DC-C97BF85A391B

The ID of the request.

Items Array of DBInstanceIPArray

Details of the IP address whitelists.

DBInstanceIPArray
DBInstanceIPArrayName String default

The name of the IP address whitelist.

SecurityIPList String 127.0.0.1

The IP addresses listed in the whitelist. You can add up to 1,000 IP addresses to the whitelist. Separate multiple IP addresses with commas (,). The IP addresses must use one of the following formats:

  • 0.0.0.0/0
  • 10.23.12.24. This is a standard IP address.
  • 10.23.12.24/24. This is a CIDR block. The value /24 indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of 1 to 32.
DBInstanceIPArrayAttribute String hidden

The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the hidden attribute does not appear in the console.

Examples

Sample requests

http(s)://gpdb.aliyuncs.com/?Action=DescribeDBInstanceIPArrayList
&DBInstanceId=gp-bp***************
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceIPArrayListResponse>
<Items>
    <DBInstanceIPArray>
        <DBInstanceIPArrayName>default</DBInstanceIPArrayName>
        <DBInstanceIPArrayAttribute>hidden</DBInstanceIPArrayAttribute>
        <securityIPList>127.0.0.1</securityIPList>
    </DBInstanceIPArray>
</Items>
<RequestId>CB7AA0BF-BE41-480E-A3DC-C97BF85A391B</RequestId>
</DescribeDBInstanceIPArrayListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.