Modifies the IP address whitelists of a cluster.
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 |
|---|---|---|---|---|
| adb:ModifyDBClusterAccessWhiteList | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The cluster ID. | rm-uf6wjk5xxxxxxxxxx |
| SecurityIps | string | Yes | The IP addresses that you want to use to modify the IP address whitelist of the cluster. Separate multiple IP addresses with commas (,). You can specify up to 500 distinct IP addresses. The following formats are supported:
Note
This parameter must be specified unless ModifyMode is set to Delete.
| 10.23.12.24 |
| DBClusterIPArrayName | string | No | The name of the IP address whitelist that you want to modify. Default value: Default. The name of an IP address whitelist must be 2 to 32 characters in length. The name can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or digit. Each cluster supports up to 50 IP address whitelists. | test |
| DBClusterIPArrayAttribute | string | No | The attribute of the IP address whitelist. By default, this parameter is empty. The IP address whitelists that have the hidden attribute are not displayed in the console. These IP address whitelists are used to access services such as Data Transmission Service (DTS) and PolarDB-X. | hidden |
| ModifyMode | string | No | The method that you want to use to modify the IP address whitelist. Valid values:
Default value: Cover. | Cover |
Response parameters
Examples
Sample success responses
JSONformat
{
"TaskId": 1564657730,
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
"DBClusterId": "rm-uf6wjk5xxxxxxxxxx"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | SecurityIPList.Duplicate | The specified IP address is duplicate. | The specified IP address is duplicate. |
| 400 | InvalidSecurityIPList.Malformed | The specified SecurityIPList is incorrectly formatted. | The specified security group parameter is invalid. |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | The specified IP address is duplicate. Specify a valid IP address. |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-04-06 | The Error code has changed | View Change Details |