You can call this operation to query the IP address whitelists of a cluster.

Request parameters

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

Response parameters

Parameter Type Description
DBClusterAccessWhiteList list<IPArray> The list of IP address whitelists.
RequestId String The ID of the request.

IPArray parameters

Parameter Type Description
DBClusterIPArrayName String The name of the IP address whitelist.
DBClusterIPArrayAttribute String
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.
SecurityIPList String The IP addresses in the IP address whitelist. Up to 1,000 IP addresses can be returned. Multiple IP addresses are separated by commas (,).

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDBClusterAccessWhitelistResponse>  
    <DBClusterAccessWhiteList>
        <IPArray>
            <DBClusterIPArrayAttribute></DBClusterIPArrayAttribute>
            <DBClusterIPArrayName>default</DBClusterIPArrayName>
            <SecurityIPList>127.0.0.1</SecurityIPList>
        </IPArray>
    </DBClusterAccessWhiteList>
    <RequestId>905F13A4-5097-4897-A84D-527EC75FFF4F</RequestId>
</DescribeDBClusterAccessWhitelistResponse>

JSON format

{
  "DBClusterAccessWhiteList": {
    "IPArray": [
      {
        "DBClusterIPArrayAttribute": "",
        "DBClusterIPArrayName": "default",
        "SecurityIPList": "127.0.0.1"
      }
    ]
  },
  "RequestId": "905F13A4-5097-4897-A84D-527EC75FFF4F"
}