Creates or modifies the whitelists (IP whitelists and security groups) of a specified 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 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 |
---|---|---|---|---|
polardb:ModifyDBClusterAccessWhitelist | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The cluster ID. | pc-************* |
SecurityIps | string | No | The IP addresses or Classless Inter-Domain Routing (CIDR) blocks in the IP whitelist group. You can add 1,000 IP addresses or CIDR blocks to all the IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:
Note
This parameter can be specified only when the WhiteListType parameter is set to IP.
| 10.23.12.24 |
DBClusterIPArrayName | string | No | The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.
Note
| default |
DBClusterIPArrayAttribute | string | No | The attributes of the IP whitelist group. Set this parameter to hidden to hide the IP whitelist group in the console. Note
| hidden |
WhiteListType | string | No | The type of the whitelist. Valid values:
Default value: IP. | IP |
SecurityGroupIds | string | No | The ID of the security group. Separate multiple security groups with commas (,). Note
| sg-********* |
ModifyMode | string | No | The method used to modify the IP whitelist. Valid values:
Note
This parameter can be specified only when the WhiteListType parameter is set to IP.
| Cover |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | NumberExceed.securityGroupIds | The number of SecurityGroupIds exceeds 10. | The number of security groups cannot exceed 10. Modify the parameter and try again. |
400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | The specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses. |
400 | InvalidSecurityIPList.Format | Specified security IP list format is not valid. | The format of the specified IP address in the whitelist is invalid. |
400 | LockTimeout | The request processing has failed due to lock timeout. | Failed to process the request due to a lock timeout. |
403 | SecurityIPList.Duplicate | Specified same security IP already exists. | The specified security group IP address already exists. |
403 | OperationDenied.LockMode | The operation is not permitted when the instance is locked. | This operation is not supported while the cluster is in the locked state. |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-06-12 | The Error code has changed | see changesets | ||||||||
| ||||||||||
2023-04-24 | The Error code has changed | see changesets | ||||||||
|