Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Rules/ Adding a Precise Protection Rule to Multiple Policies At Once

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

View PDF

Adding a Precise Protection Rule to Multiple Policies At Once

Function

This API is used to add a precise protection rule to multiple policies at once.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/rule/custom

**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 The value contains 32 characters. Only letters and digits are supported. 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
policyids	No	Array of strings	Definition Policy ID list. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,). Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	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
time	Yes	Boolean	Time when the precise protection rule takes effect. false: The rule takes effect immediately. true: The rule takes effect at a customized time.
start	No	Long	Timestamp (s) when the precise protection rule takes effect. This parameter is required when time is set to true.
terminal	No	Long	Timestamp (s) when the precise protection rule expires. This parameter is required when time is set to true.
description	No	String	Rule description.
conditions	Yes	Array of CustomConditions objects	Match condition list.
action	Yes	CustomAction object	Protective action of the precise protection rule.
priority	Yes	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
name	Yes	String	Rule name.
policy_ids	Yes	Array of strings	IDs of policies to which rules are added. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,).

**Table 5** CustomConditions
Parameter	Mandatory	Type	Description
category	No	String	Field type. The options can be url, user-agent, ip, params, cookie, referer, header, request_line, method, or request.
index	No	String	Subfield type. If the field type is set to url, user-agent, ip, referer, request_line, method, or request, index can be null. If the field type is set to params, header, or cookie and subfields are customized, index is set to the target custom subfield.
logic_operation	No	String	Condition matching logic. If the field type category is url, user-agent, or referer, the matching logic can be contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, or len_not_equal. If the field type category is ip, the matching logic can be equal, not_equal, equal_any, or not_equal_all. If the field type category is method, the matching logic can be equal or not_equal. - If the field type category is request_line or request, the matching logic can be len_greater, len_less, len_equal, or len_not_equal. If the field type category is params, cookie, or header, the matching logic can be contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist, or not_exist.
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.

**Table 6** CustomAction
Parameter	Mandatory	Type	Description
category	Yes	String	Operation type. block: WAF blocks detected attacks. pass: WAF allows requests. log: WAF only logs detected attacks.
followed_action_id	No	String	ID of a known attack source rule. This parameter can be configured only when category is set to block.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
id	String	Rule ID.
name	String	Rule name.
policyid	String	Policy ID.
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
conditions	Array of conditions objects	List of matching conditions. All conditions must be met.
action	CustomAction object	Protective action of the precise protection rule.
action_mode	Boolean	This parameter is reserved and can be ignored.
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
timestamp	Long	Timestamp when the precise protection rule is created.
time	Boolean	Time when the precise protection rule takes effect. false: The rule takes effect immediately. true: The rule takes effect at a customized time.
start	Long	Timestamp (ms) when the precise protection rule takes effect. This parameter is returned only when time is set to true.
terminal	Long	Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is set to true.
producer	Integer	This parameter is reserved and can be ignored.

**Table 8** conditions
Parameter	Type	Description
category	String	Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
index	String	Subfield When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required. If the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
logic_operation	String	Condition matching logic.
contents	Array of strings	Content of the conditions.
value_list_id	String	Reference table ID.

**Table 9** CustomAction
Parameter	Type	Description
category	String	Operation type. block: WAF blocks detected attacks. pass: WAF allows requests. log: WAF only logs detected attacks.
followed_action_id	String	ID of a known attack source rule. This parameter can be configured only when category is set to block.

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

Select multiple policies and add a precise protection rule to them all at once.

POST https://{endpoint}/v1/{project_id}/waf/rule/custom?enterprise_project_id=0

{
  "action" : {
    "category" : "block"
  },
  "priority" : 50,
  "description" : "",
  "time" : false,
  "name" : "test2",
  "conditions" : [ {
    "category" : "header",
    "logic_operation" : "contain",
    "index" : "demo",
    "contents" : [ "demo" ]
  } ],
  "policy_ids" : [ "policy_id" ]
}

Example Responses

Status code: 200

Definition

Constraints

N/A

Range

N/A

Default Value

N/A

{
  "action" : {
    "category" : "block"
  },
  "priority" : 50,
  "description" : "",
  "time" : false,
  "name" : "test2",
  "conditions" : [ {
    "category" : "header",
    "logic_operation" : "contain",
    "index" : "demo",
    "contents" : [ "demo" ]
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Select multiple policies and add a precise protection rule to them all at once.

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

    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();
        BatchCreateCustomRuleRequest request = new BatchCreateCustomRuleRequest();
        BatchCreateCustomRuleRequestBody body = new BatchCreateCustomRuleRequestBody();
        List<String> listbodyPolicyIds = new ArrayList<>();
        listbodyPolicyIds.add("policy_id");
        CustomAction actionbody = new CustomAction();
        actionbody.withCategory(CustomAction.CategoryEnum.fromValue("block"));
        List<String> listConditionsContents = new ArrayList<>();
        listConditionsContents.add("demo");
        List<CustomConditions> listbodyConditions = new ArrayList<>();
        listbodyConditions.add(
            new CustomConditions()
                .withCategory(CustomConditions.CategoryEnum.fromValue("header"))
                .withIndex("demo")
                .withLogicOperation("contain")
                .withContents(listConditionsContents)
        );
        body.withPolicyIds(listbodyPolicyIds);
        body.withName("test2");
        body.withPriority(50);
        body.withAction(actionbody);
        body.withConditions(listbodyConditions);
        body.withDescription("");
        body.withTime(false);
        request.withBody(body);
        try {
            BatchCreateCustomRuleResponse response = client.batchCreateCustomRule(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());
        }
    }
}
 
 
  

Select multiple policies and add a precise protection rule to them all at once.

     # 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 = BatchCreateCustomRuleRequest()
        listPolicyIdsbody = [
            "policy_id"
        ]
        actionbody = CustomAction(
            category="block"
        )
        listContentsConditions = [
            "demo"
        ]
        listConditionsbody = [
            CustomConditions(
                category="header",
                index="demo",
                logic_operation="contain",
                contents=listContentsConditions
            )
        ]
        request.body = BatchCreateCustomRuleRequestBody(
            policy_ids=listPolicyIdsbody,
            name="test2",
            priority=50,
            action=actionbody,
            conditions=listConditionsbody,
            description="",
            time=False
        )
        response = client.batch_create_custom_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)
 
 
  

Select multiple policies and add a precise protection rule to them all at once.

     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.BatchCreateCustomRuleRequest{}
	var listPolicyIdsbody = []string{
        "policy_id",
    }
	actionbody := &model.CustomAction{
		Category: model.GetCustomActionCategoryEnum().BLOCK,
	}
	var listContentsConditions = []string{
        "demo",
    }
	categoryConditions:= model.GetCustomConditionsCategoryEnum().HEADER
	indexConditions:= "demo"
	logicOperationConditions:= "contain"
	var listConditionsbody = []model.CustomConditions{
        {
            Category: &categoryConditions,
            Index: &indexConditions,
            LogicOperation: &logicOperationConditions,
            Contents: &listContentsConditions,
        },
    }
	descriptionBatchCreateCustomRuleRequestBody:= ""
	request.Body = &model.BatchCreateCustomRuleRequestBody{
		PolicyIds: listPolicyIdsbody,
		Name: "test2",
		Priority: int32(50),
		Action: actionbody,
		Conditions: listConditionsbody,
		Description: &descriptionBatchCreateCustomRuleRequestBody,
		Time: false,
	}
	response, err := client.BatchCreateCustomRule(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	Definition OK Constraints N/A Range N/A Default Value N/A
400	Definition Request failed. Constraints N/A Range N/A Default Value N/A
401	Definition The token does not have required permissions. Constraints N/A Range N/A Default Value N/A
500	Definition Internal server error. Constraints N/A Range N/A Default Value N/A

Error Codes

See Error Codes.

Parent Topic: Managing Rules

Previous topic: Querying Protection Rules of a Specified Type in All Policies

Next topic: Querying the Precise Protection Rules in All Policies

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