All Products
Document Center


Last Updated: Aug 14, 2020

Modifies an IP address whitelist of an AnalyticDB for MySQL cluster.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDbClusterAccessWhiteList The operation that you want to perform. Set the value to


DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose IP address whitelist is to be modified.
SecurityIps String Yes The IP addresses in a whitelist. Separate multiple IP addresses with commas (,). You can specify a maximum of 500 unique IP addresses in a whitelist. You can add IP addresses in one of the following formats:
  • Standard IP address, such as
  • Classless Inter-Domain Routing (CIDR) block, such as, where 24 indicates that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value in the range of 1 to 32.

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

DBClusterIPArrayName String No test The name of the IP address whitelist to be modified. Default value: Default.

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

You can create up to 50 IP address whitelists for a cluster.

DBClusterIPArrayAttribute String No hidden The attribute of the IP address whitelist. This parameter is not specified by default.

The console does not display whitelists with the “hidden” attribute. These whitelists are used to access Data Transformation Services (DTS) and Distributed Relational Database Service (DRDS).

ModifyMode String No Cover The method used to modify the IP address whitelist. Valid values:
  • Cover: Overwrite the original IP address whitelist.
  • Append: Add IP addresses to the original IP address whitelist.
  • Delete: Delete IP addresses from the original IP address whitelist.

Default value: Cover

Response parameters

Parameter Type Example Description
DBClusterId String rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose IP address whitelist was modified.


Sample requests

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

Sample success responses

XML format

  1. <ModifyDBClusterAccessWhitelistResponse>
  2. <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
  3. </ModifyDBClusterAccessWhitelistResponse>

JSON format

  1. {
  2. "RequestId":"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
  3. }