Querying a Known Attack Source Rule by ID¶

Function¶

This API is used to query a known attack source rule by ID.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	project_id
policy_id	Yes	String	Policy ID. It can be obtained by calling the ListPolicy API.
rule_id	Yes	String	ID of the known attack source rule. It can be obtained by calling the ListPunishmentRules API.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token
Content-Type	No	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.
block_time	Integer	Block duration, in seconds.
category	String	Type of the known attack source rule. Enumeration values: long_ip_block long_cookie_block long_params_block short_ip_block short_cookie_block short_params_block
description	String	Rule description.
timestamp	Long	Timestamp the rule was created.

Status code: 400

**Table 4** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 5** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests¶

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/punishment/{rule_id}?

Example Responses¶

Status code: 200

Request succeeded.

{
  "block_time" : 1233,
  "category" : "long_ip_block",
  "description" : "demo",
  "id" : "2c3afdcc982b429da4f72ee483aece3e",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "timestamp" : 1668148186106
}

Status Codes¶

Status Code	Description
200	Request succeeded.
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes¶

See Error Codes.

last updated: UTC - commit: