Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Rules/ Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule

Updated on 2026-05-12 GMT+08:00

View PDF

Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule

Function

This API is used to create a global protection whitelist (formerly false alarm masking) rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/ignore

**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
domain	Yes	Array of strings	Domain names or websites to be protected. If the array length is 0, the rule takes effect for all domain names or websites. If Cloud Mode - Load balancer access is used for the domain name, set this parameter in the format of [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:<id>, for example, www.example.com:b061fb5b-8ea0-4357-b0f4-cb6178ab378a. If all listeners of the load balancer bound to the domain name are protected by WAF, set this parameter to the load balancer ID. Otherwise, set this parameter to the listener ID. To query the load balancer ID bound to the domain name, use the ShowPremiumHost API. To query the listener ID, check the API documentation of ELB in the help center.
conditions	Yes	Array of CreateCondition objects	Condition list
mode	Yes	Integer	The value is fixed at 1, indicating v2 false alarm masking rules. v1 is used only for compatibility with earlier versions, and false alarm rules cannot be created in v1.
rule	Yes	String	Definition Rule to be masked. Constraints The options vary depending on the value of unchecked modules. Range Ignore WAF Protection bypass: all modules The basic web protection modules can be classified based on: ID: built-in rule ID. You can obtain the ID through the ListWebBasicProtectionRules API. Separate multiple IDs with semicolons (;). Example: "000000;111111" Type: Separate multiple types with semicolons (;). Example: "xss;webshell" xss: XSS attacks webshell: website Trojans vuln: other types of attacks sqli: SQL injections robot: malicious crawlers rfi: remote file inclusion attacks lfi: local file inclusion attacks cmdi: command injections All built-in rules illegal: illegal request Default Value N/A
advanced	No	IgnoreAdvanced object	"Advanced settings.
description	No	String	Description of a masking rule

**Table 5** CreateCondition
Parameter	Mandatory	Type	Description
category	Yes	String	Definition Field type. Constraints N/A Range url: path. custom_geoip: geolocation of the client IP address. robot: known feature crawler. user-agent: User Agent ip: IPv4 ipv6: IPv6 params: Params cookie: Cookie referer: Referer header: Header method: Method request_line: Request Line request: Request protocol: Protocol request_body: Request Body Default Value N/A
index	No	String	Definition Subfield. Constraints The value varies with the field type. Range custom_geoip: v4: IPv4 v6: IPv6 any: IPv4 or IPv6 ip/ipv6: null: client IP address x-forwarded-for: IP address recorded in the X-Forwarded-For of the request header $remote_addr: TCP connection IP address $remote_sockaddr: Layer 3 source IP address params/cookie/header: If check_all_indexes_logic is null, the subfield name can be customized. If check_all_indexes_logic is not null, the value must be null. Other field types are not supported. The default value is null. Default Value N/A
logic_operation	Yes	String	Definition Matching Logic Constraints The matching logic varies depending on field types. Range url/user-agent/referer: 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. custom_geoip: belong: Belong to. not_belong: Do not belong to. robot: match: Match the content. not_match: Do not match the content. ip/ipv6: equal_any: Equal to any value. not_equal_all: Not equal to any value. equal: Equal to. not_equal: Do not equal to. params/cookie/header: 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. num_equal: The number equals to. num_not_equal: The number does not equal to. num_greater: The number is greater than. num_less: The number is less than. exist: The content exists. not_exist: The content does not exist. regular_match: Match the regular expression. regular_not_match: Do not match the regular expression. method/protocol: equal: Equal to. not_equal: Do not equal to. request_line: 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. request: 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. request_body: contain: Contain the content. contain_any: Include any value. not_contain: Do not contain the content. not_contain_all: Exclude any value. 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 does not end with any or all. Range The value contains 1 to 4096 characters. The content format varies according to the category and logic_operation parameters. logic_operation (numeric comparison type): The value is a number. url: URL format. Only one matching content is supported. custom_geoip: Country or region to which the client IP address belongs. Use vertical bars (\|) to separate multiple locations, for example, BJ\|SH. robot: List of known crawlers. You can select multiple crawlers. crawler_engine: Search engine. crawler_scanner: Scanner. crawler_script: script tool. crawler_other: Other crawlers. ip: IPv4 ipv6: IPv6 address referer: For example, http://test.com. params: Do not include ampersands (&). user-agent/cookie/header/request_body: No restriction. method: The method supported by the HTTP protocol. The letters are in uppercase. protocol: http https Default Value N/A
check_all_indexes_logic	No	Integer	Definition This parameter is transferred when all or any subfields need to be checked. Constraints This parameter is supported only when category is set to params, cookie, or header. Range 1: all subfields 2: any subfield 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

**Table 6** IgnoreAdvanced
Parameter	Mandatory	Type	Description
index	No	String	Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart. If you select Params, Cookie, or Header, you can select All or configure subfields you need. If you select Body or Multipart, you can select All.
contents	No	Array of strings	Subfield of the specified field type. The default value is all.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
id	String	Rule ID
policyid	String	Policy ID
timestamp	Long	Timestamp the rule was created.
description	String	Rule Description
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
rule	String	Type or ID of the rule to be masked.
mode	Integer	The value is fixed at 1, indicating v2 false alarm masking rules are used. v1 is used only for compatibility with earlier versions, and false alarm rules cannot be created in v1.
conditions	Array of Condition objects	Condition list
multiCondition	Boolean	multiCondition
producer	Integer	Reference table source: 1 represents user creation, other values represent automatic generation by modulleX.
advanced	IgnoreAdvanced object	"Advanced settings.
domain	Array of strings	Protected domain name or website

**Table 8** Condition
Parameter	Type	Description
category	String	Field type. The value can be ip, url, params, cookie, or header.
contents	Array of strings	Content. The array length must be 1. The content format varies depending on field types. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be a URL in standard format. If the field type is params, cookie, or header, the content format is not limited.
logic_operation	String	Matching logics. The matching logic varies depending on field types. If the field type is ip, equal and not_equal are supported. If the field type is url, header, params, or cookie, equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix, regular_match, and regular_not_match are supported.
check_all_indexes_logic	Integer	If the field type is url or ip, the check_all_indexes_logic field does not exist. In other cases, the value 1 indicates that all subfields will be checked, the value 2 indicates that any subfield will be checked, and the valuenull indicates that custom subfields will be used.
index	String	If the field type is ip and the subfield is the client IP address, the index parameter does not exist. If the subfield type is X-Forwarded-For, the value is x-forwarded-for. If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield.

**Table 9** IgnoreAdvanced
Parameter	Type	Description
index	String	Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart. If you select Params, Cookie, or Header, you can select All or configure subfields you need. If you select Body or Multipart, you can select All.
contents	Array of strings	Subfield of the specified field type. The default value is all.

Status code: 400

**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: 401

**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.

Status code: 500

**Table 14** 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 15** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Example Requests

Create a global protection whitelist (formerly false alarm masking) rule in the protection policy with ID policy_id in the project with ID project_id. Ignore a rule for a protected domain name. Protected domain name: we.test.418lab.cn; rule condition: URL that contains x.x.x.x; rule description: demo; and rule ID: 091004.

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0

{
  "domain" : [ "we.test.418lab.cn" ],
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "contents" : [ "x.x.x.x" ],
    "index" : null
  } ],
  "mode" : 1,
  "description" : "demo",
  "rule" : "091004"
}

Example Responses

Status code: 200

{
  "id" : "a57f20ced01e4e0d8bea8e7c49eea254",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "timestamp" : 1650522310447,
  "description" : "demo",
  "status" : 1,
  "rule" : "091004",
  "mode" : 1,
  "conditions" : [ {
    "category" : "url",
    "contents" : [ "x.x.x.x" ],
    "logic_operation" : "contain"
  } ],
  "domain" : [ "we.test.418lab.cn" ]
}

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 CreateIgnoreRuleSolution {

    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();
        CreateIgnoreRuleRequest request = new CreateIgnoreRuleRequest();
        request.withPolicyId("{policy_id}");
        CreateIgnoreRuleRequestBody body = new CreateIgnoreRuleRequestBody();
        List<String> listConditionsContents = new ArrayList<>();
        listConditionsContents.add("x.x.x.x");
        List<CreateCondition> listbodyConditions = new ArrayList<>();
        listbodyConditions.add(
            new CreateCondition()
                .withCategory(CreateCondition.CategoryEnum.fromValue("url"))
                .withLogicOperation(CreateCondition.LogicOperationEnum.fromValue("contain"))
                .withContents(listConditionsContents)
        );
        List<String> listbodyDomain = new ArrayList<>();
        listbodyDomain.add("we.test.418lab.cn");
        body.withDescription("demo");
        body.withRule("091004");
        body.withMode(1);
        body.withConditions(listbodyConditions);
        body.withDomain(listbodyDomain);
        request.withBody(body);
        try {
            CreateIgnoreRuleResponse response = client.createIgnoreRule(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 = CreateIgnoreRuleRequest()
        request.policy_id = "{policy_id}"
        listContentsConditions = [
            "x.x.x.x"
        ]
        listConditionsbody = [
            CreateCondition(
                category="url",
                logic_operation="contain",
                contents=listContentsConditions
            )
        ]
        listDomainbody = [
            "we.test.418lab.cn"
        ]
        request.body = CreateIgnoreRuleRequestBody(
            description="demo",
            rule="091004",
            mode=1,
            conditions=listConditionsbody,
            domain=listDomainbody
        )
        response = client.create_ignore_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.CreateIgnoreRuleRequest{}
	request.PolicyId = "{policy_id}"
	var listContentsConditions = []string{
        "x.x.x.x",
    }
	var listConditionsbody = []model.CreateCondition{
        {
            Category: model.GetCreateConditionCategoryEnum().URL,
            LogicOperation: model.GetCreateConditionLogicOperationEnum().CONTAIN,
            Contents: &listContentsConditions,
        },
    }
	var listDomainbody = []string{
        "we.test.418lab.cn",
    }
	descriptionCreateIgnoreRuleRequestBody:= "demo"
	request.Body = &model.CreateIgnoreRuleRequestBody{
		Description: &descriptionCreateIgnoreRuleRequestBody,
		Rule: "091004",
		Mode: int32(1),
		Conditions: listConditionsbody,
		Domain: listDomainbody,
	}
	response, err := client.CreateIgnoreRule(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: Querying Global Protection Whitelist (Formerly False Alarm Masking) Rules

Next topic: Querying the Reference Table List

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