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	Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range N/A Default Value N/A
policy_id	Yes	String	Definition Protection policy ID. You can call the ListPolicy API to obtain the policy ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range 0: the default enterprise project. all_granted_eps: all enterprise projects. A specific enterprise project ID: Enter a maximum of 36 characters. Default Value 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
conditions	Yes	Array of AnticrawlerCondition objects	Match condition list. A maximum of 30 conditions are supported.
name	Yes	String	Definition Rule name. Constraints Length range: [1, 256] Range N/A Default Value N/A
type	Yes	String	Definition Type of the JavaScript-based anti-crawler rule. Constraints The bucket name cannot be modified after being created. Range anticrawler_except_url: All paths are protected except the one specified in the queried JavaScript-based anti-crawler rule. anticrawler_specific_url: Only the path specified in queried JavaScript-based anti-crawler rule is protected. Default Value anticrawler_except_url
priority	Yes	Integer	Definition Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Constraints N/A Range [0, 65535] Default Value N/A

**Table 5** AnticrawlerCondition
Parameter	Mandatory	Type	Description
category	Yes	String	Definition Field type. Constraints N/A Range url user-agent Default Value N/A
logic_operation	Yes	String	Definition Condition matching logic. Constraints N/A Range contain_any: Include any value. not_contain_all: Exclude any value. equal_any: Equal to any value. not_equal_all: Not equal to any value. prefix_any: Prefix matches any value. not_prefix_all: Prefix does not match any of them. suffix_any: Suffix matches any value. not_suffix_all: Suffix does not match any of them. contain: Contain the content. not_contain: Do not contain the content. equal: Equal to. not_equal: Do not equal to. prefix: Match the prefix. not_prefix: Do not match the prefix. suffix: Match the suffix. not_suffix: Do not match the suffix. len_equal: Length equal to. len_not_equal: Length not equal to. len_greater: Length greater than. len_less: Length less than. len_greater_equal: Length greater than or equal to. len_less_equal: Length less than or equal to. regular_match: Match the regular expression. regular_not_match: Do not match the regular expression. Default Value N/A
contents	No	Array of strings	Definition Content for the matching logic in the condition list. Constraints This parameter is mandatory when the value of logic_operation ends with any or all. Only one matching content is supported. Range The value contains 1 to 4096 characters. Default Value N/A
value_list_id	No	String	Definition ID of the referenced table. Constraints This parameter is mandatory when the value of logic_operation ends with any or all. The type of the referenced table must be the same as that of category. Range Obtain the referenced table ID through the ListValueList API. Default Value N/A

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	Definition Type of the JavaScript-based anti-crawler rule. Constraints N/A Range anticrawler_except_url: All paths are protected except the one specified in the queried JavaScript-based anti-crawler rule. anticrawler_specific_url: Only the path specified in queried JavaScript-based anti-crawler rule is protected. Default Value anticrawler_except_url
timestamp	Long	Timestamp the rule is created.
status	Integer	Definition Rule status, which is used to specify whether a rule is enabled or disabled. Constraints N/A Range 0: disabled 1: enabled Default Value N/A
priority	Integer	Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 65,535

**Table 7** AnticrawlerCondition
Parameter	Type	Description
category	String	Definition Field type. Constraints N/A Range url user-agent Default Value N/A
logic_operation	String	Definition Condition matching logic. Constraints N/A Range contain_any: Include any value. not_contain_all: Exclude any value. equal_any: Equal to any value. not_equal_all: Not equal to any value. prefix_any: Prefix matches any value. not_prefix_all: Prefix does not match any of them. suffix_any: Suffix matches any value. not_suffix_all: Suffix does not match any of them. contain: Contain the content. not_contain: Do not contain the content. equal: Equal to. not_equal: Do not equal to. prefix: Match the prefix. not_prefix: Do not match the prefix. suffix: Match the suffix. not_suffix: Do not match the suffix. len_equal: Length equal to. len_not_equal: Length not equal to. len_greater: Length greater than. len_less: Length less than. len_greater_equal: Length greater than or equal to. len_less_equal: Length less than or equal to. regular_match: Match the regular expression. regular_not_match: Do not match the regular expression. Default Value N/A
contents	Array of strings	Definition Content for the matching logic in the condition list. Constraints This parameter is mandatory when the value of logic_operation ends with any or all. Only one matching content is supported. Range The value contains 1 to 4096 characters. Default Value N/A
value_list_id	String	Definition ID of the referenced table. Constraints This parameter is mandatory when the value of logic_operation ends with any or all. The type of the referenced table must be the same as that of category. Range Obtain the referenced table ID through the ListValueList API. Default Value N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 9** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 11** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 13** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

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

{
  "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.

     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(AnticrawlerCondition.LogicOperationEnum.fromValue("contain"))
                .withContents(listConditionsContents)
        );
        body.withPriority(50);
        body.withType(CreateAnticrawlerRuleRequestbody.TypeEnum.fromValue("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());
        }
    }
}
 
 
  

     # 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)
 
 
  

     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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    request := &model.CreateAnticrawlerRuleRequest{}
	request.PolicyId = "{policy_id}"
	var listContentsConditions = []string{
        "/test66",
    }
	var listConditionsbody = []model.AnticrawlerCondition{
        {
            Category: model.GetAnticrawlerConditionCategoryEnum().URL,
            LogicOperation: model.GetAnticrawlerConditionLogicOperationEnum().CONTAIN,
            Contents: &listContentsConditions,
        },
    }
	request.Body = &model.CreateAnticrawlerRuleRequestbody{
		Priority: int32(50),
		Type: model.GetCreateAnticrawlerRuleRequestbodyTypeEnum().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.

Parent Topic: Managing Rules

Previous topic: Updating a JavaScript Anti-Crawler Protection Rule

Next topic: Querying a JavaScript Anti-Crawler Rule

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot