Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Creating a JavaScript Anti-Crawler Rule
Updated on 2024-07-02 GMT+08:00

Creating a JavaScript Anti-Crawler Rule

Function

This API is used to create a JavaScript anti-crawler rule. Before invoking this API, you need to call the UpdateAnticrawlerRuleType API to specify the protection mode.

Calling Method

For details, see Calling APIs.

URI

POST /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 Huawei 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.

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.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

conditions

Yes

Array of AnticrawlerCondition objects

Condition list.

name

Yes

String

Rule name.

type

Yes

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.

priority

Yes

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 5 AnticrawlerCondition

Parameter

Mandatory

Type

Description

category

No

String

Field type.

logic_operation

No

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

No

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

No

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.

Response Parameters

Status code: 200

Table 6 Response body parameters

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 7 AnticrawlerCondition

Parameter

Type

Description

category

String

Field type.

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 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

The following example shows how to create a JavaScript-based anti-crawler rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The rule name is test66, the rule type is excluding protection paths, the match condition is url that contains /test66, and the priority is 50.

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

{
  "name" : "test66",
  "type" : "anticrawler_except_url",
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "contents" : [ "/test66" ]
  } ],
  "priority" : 50
}

Example Responses

Status code: 200

ok

{
  "id" : "7e7983bf2c9c41029d642bcbf819346d",
  "policyid" : "0681f69f94ac408e9688373e45a61fdb",
  "name" : "test66",
  "timestamp" : 1678931492172,
  "status" : 1,
  "type" : "anticrawler_except_url",
  "conditions" : [ {
    "category" : "url",
    "contents" : [ "/test66" ],
    "logic_operation" : "contain"
  } ],
  "priority" : 50
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to create a JavaScript-based anti-crawler rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The rule name is test66, the rule type is excluding protection paths, the match condition is url that contains /test66, and the priority is 50.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateAnticrawlerRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAnticrawlerRuleRequest request = new CreateAnticrawlerRuleRequest();
        request.withPolicyId("{policy_id}");
        CreateAnticrawlerRuleRequestbody body = new CreateAnticrawlerRuleRequestbody();
        List<String> listConditionsContents = new ArrayList<>();
        listConditionsContents.add("/test66");
        List<AnticrawlerCondition> listbodyConditions = new ArrayList<>();
        listbodyConditions.add(
            new AnticrawlerCondition()
                .withCategory(AnticrawlerCondition.CategoryEnum.fromValue("url"))
                .withLogicOperation("contain")
                .withContents(listConditionsContents)
        );
        body.withPriority(50);
        body.withType("anticrawler_except_url");
        body.withName("test66");
        body.withConditions(listbodyConditions);
        request.withBody(body);
        try {
            CreateAnticrawlerRuleResponse response = client.createAnticrawlerRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

The following example shows how to create a JavaScript-based anti-crawler rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The rule name is test66, the rule type is excluding protection paths, the match condition is url that contains /test66, and the priority is 50.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAnticrawlerRuleRequest()
        request.policy_id = "{policy_id}"
        listContentsConditions = [
            "/test66"
        ]
        listConditionsbody = [
            AnticrawlerCondition(
                category="url",
                logic_operation="contain",
                contents=listContentsConditions
            )
        ]
        request.body = CreateAnticrawlerRuleRequestbody(
            priority=50,
            type="anticrawler_except_url",
            name="test66",
            conditions=listConditionsbody
        )
        response = client.create_anticrawler_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example shows how to create a JavaScript-based anti-crawler rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The rule name is test66, the rule type is excluding protection paths, the match condition is url that contains /test66, and the priority is 50.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAnticrawlerRuleRequest{}
	request.PolicyId = "{policy_id}"
	var listContentsConditions = []string{
        "/test66",
    }
	categoryConditions:= model.GetAnticrawlerConditionCategoryEnum().URL
	logicOperationConditions:= "contain"
	var listConditionsbody = []model.AnticrawlerCondition{
        {
            Category: &categoryConditions,
            LogicOperation: &logicOperationConditions,
            Contents: &listContentsConditions,
        },
    }
	request.Body = &model.CreateAnticrawlerRuleRequestbody{
		Priority: int32(50),
		Type: "anticrawler_except_url",
		Name: "test66",
		Conditions: listConditionsbody,
	}
	response, err := client.CreateAnticrawlerRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.