DescribeDBClusterAccessWhiteList - ApsaraDB for ClickHouse

Queries the IP address whitelist of an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****

Response parameters

Parameter	Type	Description	Example
	object
DBClusterAccessWhiteList	array<object>	The details about the IP address whitelist.
	object
DBClusterIPArrayAttribute	string	The attribute of the IP address whitelist.	default
SecurityIPList	string	The IP addresses in the IP address whitelist.	192.168.xx.xx,192.168.xx.xx
DBClusterIPArrayName	string	The name of the IP address whitelist.	default
RequestId	string	The request ID.	905F13A4-5097-4897-A84D-527EC75FFF4F

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history