Querying a Blacklist or Whitelist Rule in a Web CC Protection Policy_AAD Protection Policies_AAD APIs_API Reference

Function

This API is used to query blacklist and whitelist rules in a web CC protection policy.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/aad/policies/waf/blackwhite-list

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
domain_name	Yes	String	Domain name
overseas_type	Yes	Integer	Protection region. 0: regions in the Chinese mainland. 1: regions outside the Chinese mainland.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	token
Content-Type	Yes	String	Content-Type

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	total
black	Array of BlackWhiteListRule objects	black
white	Array of BlackWhiteListRule objects	white

**Table 4** BlackWhiteListRule
Parameter	Type	Description
id	String	id
type	Integer	0: blacklist, 1: whitelist
ip	String	ip
domain_id	String	Domain name ID.

Example Requests

Query the blacklist and whitelist rule whose domain name is domainName.

GET https://{endpoint}/v2/aad/policies/waf/blackwhite-list?domain_name=domainName&overseas_type=0

Example Responses

Status code: 200

{
  "total" : 1,
  "black" : [ {
    "id" : "9fcaab33-xxxx-xxxx-xxxx-19abee92de5a",
    "type" : 0,
    "ip" : "1.x.x.1",
    "domain_id" : "579b0ccd-xxxx-xxxx-xxxx-fa163eaa216e"
  } ],
  "white" : [ {
    "id" : "579b0ccd-xxxx-xxxx-xxxx-fa163eaa216e",
    "type" : 1,
    "ip" : "1.x.x.1",
    "domain_id" : "9fcaab33-xxxx-xxxx-xxxx-19abee92de5a"
  } ]
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Querying a Blacklist or Whitelist Rule in a Web CC Protection Policy