Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance.
Operation description
To ensure the security and stability of AnalyticDB for PostgreSQL instances, the system denies all external IP addresses to access AnalyticDB for PostgreSQL instances by default. Before you can use an AnalyticDB for PostgreSQL instance, you must add the IP address or CIDR block of your client to the IP address whitelist of the 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
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 Resourcesis 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:ModifySecurityIps | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ResourceGroupId | string | No | 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. | rg-bp67acfmxazb4p**** |
| ModifyMode | string | No | The method of modification. Valid values:
| 0 |
| DBInstanceId | string | Yes | The ID of the instance. Note
You can call the DescribeDBInstances operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.
| gp-bp12ga6v69h86**** |
| SecurityIPList | string | Yes | 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:
| 10.10.**.** |
| DBInstanceIPArrayName | string | No | The name of the whitelist. If you do not enter a name, IP addresses are added to the default whitelist. Note
You can create up to 50 whitelists for an instance.
| default |
| DBInstanceIPArrayAttribute | string | No | The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the | hidden |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "871C698F-B43D-4D1D-ACD6-DF56B0F89978"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||
|---|---|---|---|---|---|---|
| 2023-05-18 | The request parameters of the API has changed | see changesets | ||||
|