Querying the JavaScript Anti-Crawler Rule List

Function

This API is used to query the list of JavaScript anti-crawler rules.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/anticrawler

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.
policy_id	Yes	String	ID of a protection policy. You can specify a protection policy ID to query the rules used in the protection policy. You can obtain the policy ID by calling the ListPolicy API.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.
offset	Yes	Integer	Offset. The records after the offset are queried.
limit	Yes	Integer	Maximum number of records that can be returned.
type	No	String	JavaScript anti-crawler rule protection mode anticrawler_except_url: In this mode, all paths are protected except the one specified in the queried anti-crawler rule. anticrawler_specific_url: In this mode, the path specified in the queried rule is protected.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	The number of anti-crawler rules in the current policy.
items	Array of AnticrawlerRule objects	The list of anti-crawler protection rules.

**Table 5** AnticrawlerRule
Parameter	Type	Description
id	String	Rule ID.
policyid	String	Policy ID.
conditions	Array of AnticrawlerCondition objects	Condition list.
name	String	Rule name.
type	String	JavaScript anti-crawler rule type. anticrawler_specific_url: used to protect a specific path specified by the rule. anticrawler_except_url: used to protect all paths except the one specified by the rule.
timestamp	Long	Timestamp the rule is created.
status	Integer	Rule status. The value can be 0 or 1. 0: The rule is disabled. 1: The rule is enabled.
priority	Integer	Priority of the rule. A smaller value indicates a higher priority. If the value is the same, the rule is created earlier and the priority is higher. Value range: 0 to 1000.

**Table 6** AnticrawlerCondition
Parameter	Type	Description
category	String	Field type. Enumeration values: url user-agent
logic_operation	String	Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI.
contents	Array of strings	Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
value_list_id	String	Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

The following example shows how to query the JavaScript-based anti-crawler protection rule list in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id.

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

Example Responses

Status code: 200

{
  "total" : 1,
  "items" : [ {
    "id" : "c06ec2e5d93241a694fcd9e0312657a1",
    "policyid" : "0681f69f94ac408e9688373e45a61fdb",
    "name" : "test",
    "timestamp" : 1678931359146,
    "status" : 1,
    "type" : "anticrawler_except_url",
    "conditions" : [ {
      "category" : "url",
      "contents" : [ "/test" ],
      "logic_operation" : "contain"
    } ],
    "priority" : 50
  } ]
}