You can call this operation to queries the IP address whitelists of an AnalyticDB for MySQL cluster.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

Response parameters

Parameter Type Example Description
Items Array of IPArray

An array that consists of the information of IP whitelists.

DBClusterIPArrayAttribute String hidden

The attribute of the whitelist group. It is empty by default.

Note The groups with hidden attribute are not displayed in the console. The groups with hidden attribute are used to access DTS and PolarDB-X.
DBClusterIPArrayName String test

The name of the IP address whitelist.

  • The name of the IP address whitelist group must be 2 to 32 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a digit or lowercase letter.
  • You can create up to 50 whitelists for a cluster.
SecurityIPList String

The IP addresses in an IP address whitelist. A maximum of 1,000 IP addresses can be returned. These addresses are separated with commas (,).

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.


Sample requests

http(s)://[Endpoint]/? Action=DescribeDBClusterAccessWhiteList
&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "Items": {
        "IPArray": {
            "DBClusterIPArrayName": "test",
            "SecurityIPList": "",
            "DBClusterIPArrayAttribute": "hidden"

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether you specify the cluster ID value correctly.

For a list of error codes, visit the API Error Center.