Updated on 2024-07-25 GMT+08:00

Querying a Blacklist or Whitelist Rule

Function

This API is used to query a blacklist/whitelist protection rule by ID.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

project_id

policy_id

Yes

String

policyid

rule_id

Yes

String

whiteblackIpRuleId

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

auth token

Content-Type

Yes

String

Content type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

addr

String

IP addresses in the blacklist or whitelist rule

description

String

Rule description

white

Integer

Protective action

  • 0: WAF blocks the requests that hit the rule.

  • 1: WAF allows the requests that hit the rule.

  • 2: WAF only logs the requests that hit the rule.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Example Requests

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}?enterprise_project_id=0

Example Responses

None

Status Codes

Status Code

Description

200

ok

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.