Help Center/ Anti-DDoS Service/ API Reference/ AAD APIs/ AAD Protection Policies/ Querying the DDoS Attack Protection Blacklist or Whitelist
Updated on 2026-09-10 GMT+08:00

Querying the DDoS Attack Protection Blacklist or Whitelist

Function

This API is used to query the blacklist and whitelist of DDoS attack protection.

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/ddos/blackwhite-list

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

white: whitelist. black: blacklist.

instance_id

Yes

String

instanceId

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

ips

Array of BwListIps objects

List of users.

Table 4 BwListIps

Parameter

Type

Description

ip

String

Blacklist/Whitelist IP addresses.

desc

String

Description

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

GET https://{endpoint}/v2/aad/policies/ddos/blackwhite-list?type=black&instance_id=8205ed60-xxxx-xxxx-8c33-c8f8cd9fc84c

Example Responses

Status code: 200

{
  "total" : 1,
  "ips" : [ {
    "ip" : "1.x.x.1"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Error response

Error Codes

See Error Codes.