Retrieve & Audit IP Whitelists via DescribeDBInstanceIPArrayList - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Operation description

Queries the IP address whitelists of an AnalyticDB for PostgreSQL instance.

Limits

You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered and your business may be affected. Take note of this limit when you call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:DescribeDBInstanceIPArrayList

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The resource group ID of the instance. For more information about how to obtain a resource group ID, see View basic information of a resource group.	null
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in 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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CB7AA0BF-BE41-480E-A3DC-C97BF85A391B
Items	object
DBInstanceIPArray	array<object>	The queried IP address whitelists.
	object
DBInstanceIPArrayName	string	The name of the IP address whitelist.	Default
SecurityIPList	string	The IP addresses in the whitelist. A whitelist can contain up to 1,000 IP addresses, separated by commas (,). The IP addresses must be in 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 bits 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. This parameter is empty by default. A whitelist with the `hidden` attribute is not displayed in the console.	hidden

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.