All Products
Document Center


Last Updated: May 29, 2020

Queries the IP address whitelists of an AnalyticDB for MySQL cluster.

Request parameters

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


DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose IP address whitelists are to be queried.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF The ID of the request.
Items List<IPArray> The information about IP address whitelists.


Parameter Type Example Description
DBClusterIPArrayName String test The name of an IP address whitelist.

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 hidden The attribute of the IP address whitelist. This parameter is left empty 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).

SecurityIPList String The IP addresses in an IP address whitelist. An IP address whitelist can contain a maximum of 1,000 IP addresses separated with commas (,).


Sample requests

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

Sample success responses

XML format

  1. <DescribeDBClusterAccessWhitelistResponse>
  2. <Items>
  3. <IPArray>
  4. <DBClusterIPArrayAttribute></DBClusterIPArrayAttribute>
  5. <DBClusterIPArrayName>default</DBClusterIPArrayName>
  6. <SecurityIPList></SecurityIPList>
  7. </IPArray>
  8. </Items>
  9. <RequestId>905F13A4-5097-4897-A84D-527EC75FFF4F</RequestId>
  10. </DescribeDBClusterAccessWhitelistResponse>

JSON format

  1. {
  2. "Items": {
  3. "IPArray": [
  4. {
  5. "DBClusterIPArrayAttribute": "",
  6. "DBClusterIPArrayName": "default",
  7. "SecurityIPList": ""
  8. }
  9. ]
  10. },
  11. "RequestId": "905F13A4-5097-4897-A84D-527EC75FFF4F"
  12. }