DescribeDBInstanceIPArrayList - AnalyticDB

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

Operation 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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDBInstanceIPArrayList	get	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see View basic information of a resource group.	rg-bp67acfmxazb4p****
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-bp***************
DBInstanceIPArrayName	string	No	The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried. Note Each instance supports up to 50 IP address whitelists.	Default

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CB7AA0BF-BE41-480E-A3DC-C97BF85A391B
Items	array<object>	The queried IP address whitelists.
DBInstanceIPArray	object
DBInstanceIPArrayName	string	The name of the IP address whitelist.	default
SecurityIPList	string	The IP addresses listed in the whitelist. Up to 1,000 IP addresses are contained in a whitelist and separated by 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`.	127.0.0.1
DBInstanceIPArrayAttribute	string	The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the `hidden` attribute is not displayed in the console.	hidden

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-20	The request parameters of the API has changed	View Change Details