You can call this operation to modify an IP address whitelist of a cluster.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to ModifyDbClusterAccessWhiteList.
DBClusterId String Yes The ID of the cluster.
SecurityIps String Yes

The IP addresses in the IP address whitelist. Separate multiple IP addresses with commas (,). You can add up to 500 different IP addresses to a whitelist. For more information, see Configure a whitelist. You can add IP addresses in the following formats:

  • IP addresses. Example: 10.23.12.24.
  • CIDR blocks. Example: 10.23.12.24/24. 24 indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value within the range of 1 to 32.
    Note

    This parameter must be specified unless the ModifyMode parameter is set to Delete.

DBClusterIPArrayName String No

The name of the IP address whitelist. Default value: Default.

The name must be 2 to 32 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter, and end with a lowercase letter or digit.

Note You can create up to 50 whitelists for a cluster.
DBClusterIPArrayAttribute String No
The attribute of the whitelist. This parameter is empty by default.
Note The IP address whitelists that have the hidden attribute are not displayed in the console. These IP address whitelists are used to access Alibaba Cloud services such as Data Transmission Service (DTS) and PolarDB-X.
ModifyMode String No

The method that is used to modify the IP address whitelist. Valid values:

  • Cover: overwrites the original IP address whitelist.
  • Append: appends one or more IP addresses.
  • Delete: deletes one or more IP addresses.

Default value: Cover.

Response parameters

Parameter Type Description
RequestId String The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyDBClusterAccessWhitelist
&DBClusterId=am-xxxxxxxxx
&SecurityIps=127.0.0.1
&<[Common request parameters]>

Sample success responses

XML format

<ModifyDBClusterAccessWhitelistResponse>  
      <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterAccessWhitelistResponse>

JSON format

{
    "RequestId":"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}