Modifies the IP address whitelist of an AnalyticDB for MySQL cluster.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints.
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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ModifyClusterAccessWhiteList | update | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. | amv-bp11q28kvl688**** |
| SecurityIps | string | Yes | The IP addresses in an IP address whitelist of a cluster. Separate multiple IP addresses with commas (,). You can add a maximum of 500 different IP addresses to a whitelist. The entries in the IP address whitelist must be in one of the following formats:
| 10.23.xx.xx |
| DBClusterIPArrayName | string | No | The name of the IP address whitelist. If you do not specify this parameter, the Default whitelist is modified.
| test |
| DBClusterIPArrayAttribute | string | No | The attribute of the IP address whitelist. By default, this parameter is empty. Note
IP address whitelists with the hidden attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.
| hidden |
| ModifyMode | string | No | The method used to modify the IP address whitelist. Valid values:
| Cover |
Response parameters
Examples
Sample success responses
JSONformat
{
"TaskId": 1564657730,
"RequestId": "370D09FD-442A-5225-AAD3-7362CAE39177",
"DBClusterId": "amv-bp11q28kvl688****"
}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 | InvalidDBClusterIPArrayName.Malformed | The specified parameter DBClusterIPArrayName is not valid. | The DBClusterIPArrayName parameter is invalid. Check the parameter. |
| 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-03-31 | The Error code has changed | View Change Details |