• Web Application Firewall

waf
  1. Help Center
  2. Web Application Firewall
  3. API Reference
  4. APIs
  5. Blacklist and Whitelist Rules
  6. Querying Blacklist and Whitelist Rules

Querying Blacklist and Whitelist Rules

Function Description

This API is used to query all blacklist and whitelist rules.

URI

  • URI format

    GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip?offset={offset}&limit={limit}

  • Parameter description
    Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    policy_id

    Yes

    String

    Specifies the policy ID.

    offset

    No

    Long

    Specifies the number of returned pages. Its value ranges from 0 to 65535. The default value is 0.

    limit

    No

    Long

    Specifies the maximum number of records displayed on each page. Its value ranges from 0 to 50. The default value is 10.

Request

Request parameters

None

Response

Response parameters
Table 2 Parameter description

Parameter

Type

Description

total

Integer

Specifies the total number of rules.

items

Table 3

Specifies the blacklist or whitelist rule objects.

Table 3 items

Parameter

Type

Description

id

String

Specifies the ID of a blacklist or whitelist rule.

policyid

String

Specifies the ID of the policy to which the rule belongs.

addr

String

Specifies the IP address or range (IP address and subnet mask). For example, 192.168.0.125 or 192.168.6.0/24.

white

Integer

Specifies the IP address type.

  • 1: Whitelist
  • 0: Blacklist

timestamp

Long

Specifies the time when a blacklist or whitelist rule is added.

Example

total with a value of 2 is used as an example.

Response example
{
  "total": 2,
  "items": [{
      "id": "3a9b5c0f96784ec8abd8ba61a98064ef",
      "policyid": "ertr45c0f96784ec8abd8ba61a98064ef",
      "addr": "192.168.0.125",
      "white": 1,
      "timestamp": 1499817600
    }, {
      "id": "44d887434169475794b2717438f7fa78",
      "policyid": "ertr45c0f96784ec8abd8ba61a98064ef",
      "addr": "192.168.0.125",
      "white": 0,
      "timestamp": 1499817601
    }
  ]
}

Status Code

Table 4 describes the normal status code returned by the API.
Table 4 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.