文档首页/ Web应用防火墙 WAF/ API参考/ API/ 策略规则管理/ 批量更新全局白名单规则 - BatchUpdateIgnoreRules
更新时间：2026-03-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量更新全局白名单规则 - BatchUpdateIgnoreRules

功能介绍

批量更新全局白名单规则

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/waf/rule/ignore/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8
表3 请求Body参数

参数

是否必选

参数类型

描述

domain

是

Array of strings

防护域名或防护网站，数组长度为0时，代表规则对全部域名或防护网站生效

conditions

是

Array of CreateCondition objects

条件列表

mode

是

Integer

固定值为1,代表v2版本误报屏蔽规则，v1版本仅用于兼容旧版本，不支持创建

rule

是

String

参数解释：

需要屏蔽的规则

约束限制：

参数值根据"不检测模块"变化

取值范围：

不检测模块:

  • 所有模块: bypass

  • Web基础防护模块按照规则类型划分:

    • ID: 内置规则id，通过ListWebBasicProtectionRules接口获取ID，多个id以分号;分隔，比如："000000;111111"

    • 类别: 多个类型以分号;分隔，比如："xss;webshell"

      • xss：XSS攻击

      • webshell：网站木马

      • vuln：其他类型攻击

      • sqli：SQL注入攻击

      • robot：恶意爬虫

      • rfi：远程文件包含

      • lfi：本地文件包含

      • cmdi：命令注入攻击

    • 所有内置规则

  • 非法请求: illegal

默认取值：

不涉及

advanced

否

IgnoreAdvanced object

高级配置项

description

否

String

屏蔽规则描述

policy_rule_ids

是

Array of policy_rule_ids objects

参数解释：

策略ID和规则id数组，规则ID与规则所属的策略ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 CreateCondition

参数

是否必选

参数类型

描述

category

是

String

参数解释：

字段类型

约束限制：

不涉及

取值范围：

  • url: 路径

  • custom_geoip: 客户端IP所属的地理位置

  • robot: 已知特征爬虫

  • 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

默认取值：

不涉及

index

否

String

参数解释：

子字段

约束限制：

随字段类型变化

取值范围：

  • custom_geoip:

    • v4：ipv4

    • v6：ipv6

    • any：ipv4或ipv6

  • ip/ipv6:

    • null：客户端IP

    • x-forwarded-for：请求header中X-Forwarded-For记录的IP

    • $remote_addr：TCP连接IP

    • $remote_sockaddr：3层源IP

  • params/cookie/header：

    • check_all_indexes_logic为null： 可自定义子字段名称

    • check_all_indexes_logic不为null：必须为null

  • 其他字段类型：不支持，默认为null

默认取值：

不涉及

logic_operation

是

String

参数解释：

匹配逻辑

约束限制：

匹配逻辑根据字段类型变化

取值范围：

  • url/user-agent/referer:

    • contain_any: 包含任意一个

    • not_contain_all: 不包含全部

    • equal_any: 等于任意一个

    • not_equal_all: 不等于全部

    • prefix_any: 前缀匹配任意一个

    • not_prefix_all: 前缀不匹配全部

    • suffix_any: 后缀匹配任意一个

    • not_suffix_all: 后缀不匹配全部

    • contain: 包含

    • not_contain: 不包含

    • equal: 等于

    • not_equal: 不等于

    • prefix: 前缀匹配

    • not_prefix: 前缀不匹配

    • suffix: 后缀匹配

    • not_suffix: 后缀不匹配

    • len_equal: 长度等于

    • len_not_equal: 长度不等于

    • len_greater: 长度大于

    • len_less: 长度小于

    • len_greater_equal: 长度大于等于

    • len_less_equal: 长度小于等于

    • regular_match: 正则匹配

    • regular_not_match: 正则不匹配

  • custom_geoip:

    • belong: 属于

    • not_belong: 不属于

  • robot:

    • match: 匹配

    • not_match: 不匹配

  • ip/ipv6:

    • equal_any: 等于任意一个

    • not_equal_all: 不等于全部

    • equal: 等于

    • not_equal: 不等于

  • params/cookie/header:

    • contain_any: 包含任意一个

    • not_contain_all: 不包含全部

    • equal_any: 等于任意一个

    • not_equal_all: 不等于全部

    • prefix_any: 前缀匹配任意一个

    • not_prefix_all: 前缀不匹配全部

    • suffix_any: 后缀匹配任意一个

    • not_suffix_all: 后缀不匹配全部

    • contain: 包含

    • not_contain: 不包含

    • equal: 等于

    • not_equal: 不等于

    • prefix: 前缀匹配

    • not_prefix: 前缀不匹配

    • suffix: 后缀匹配

    • not_suffix: 后缀不匹配

    • len_equal: 长度等于

    • len_not_equal: 长度不等于

    • len_greater: 长度大于

    • len_less: 长度小于

    • len_greater_equal: 长度大于等于

    • len_less_equal: 长度小于等于

    • num_equal: 数字等于

    • num_not_equal: 数字不等于

    • num_greater: 数字大于

    • num_less: 数字小于

    • exist: 存在

    • not_exist: 不存在

    • regular_match: 正则匹配

    • regular_not_match: 正则不匹配

  • method/protocol:

    • equal: 等于

    • not_equal: 不等于

  • request_line:

    • len_equal: 长度等于

    • len_not_equal: 长度不等于

    • len_greater: 长度大于

    • len_less: 长度小于

    • len_greater_equal: 长度大于等于

    • len_less_equal: 长度小于等于

  • request:

    • len_equal: 长度等于

    • len_not_equal: 长度不等于

    • len_greater: 长度大于

    • len_less: 长度小于

    • len_greater_equal: 长度大于等于

    • len_less_equal: 长度小于等于

    • regular_match: 正则匹配

    • regular_not_match: 正则不匹配

  • request_body:

    • contain: 包含

    • contain_any: 包含任意一个

    • not_contain: 不包含

    • not_contain_all: 不包含全部

    • regular_match: 正则匹配

    • regular_not_match: 正则不匹配

默认取值：

不涉及

contents

否

Array of strings

参数解释：

条件列表逻辑匹配内容

约束限制：

当logic_operation参数不以any或者all结尾时，需要传该参数

取值范围：

匹配内容字符串长度范围：[1, 4096]

内容格式根据参数category和logic_operation变化：

  • logic_operation为数值比较类型：纯数字

  • url: URL格式；仅支持单个匹配内容

  • custom_geoip: 客户端IP所属国家或省份，多个位置以|分隔，比如："BJ|SH"

  • robot: 已知特征爬虫列表，可选择多个

    • crawler_engine：搜索引擎

    • crawler_scanner：扫描器

    • crawler_script：脚本工具

    • crawler_other：其他爬虫

  • ip: IPv4

  • ipv6: IPv6

  • referer: 例如：http://test.com

  • params：不包含&

  • user-agent/cookie/header/request_body: 无限制

  • method: HTTP协议支持的method，字母大写

  • protocol:

    • http

    • https

默认取值：

不涉及

check_all_indexes_logic

否

Integer

参数解释：

需要检查所有子字段或检查任意子字段时传此参数

约束限制：

仅当category为params/cookie/header时支持

取值范围：

  • 1：所有子字段

  • 2：任意子字段

默认取值：

不涉及

value_list_id

否

String

参数解释：

引用表ID

约束限制：

当logic_operation参数以any或者all结尾时，需要传该参数；引用表类型要与category类型保持一致

取值范围：

通过ListValueList接口获取引用表ID

默认取值：

不涉及
表5 IgnoreAdvanced

参数

是否必选

参数类型

描述

index

否

String

字段类型，支持的字段类型有：Params、Cookie、Header、Body、Multipart。

  • 当选择“Params”、“Cookie”或者“Header”字段时，可以配置“全部”或根据需求配置子字段

  • 当选择“Body”或“Multipart”字段时，可以配置“全部”

contents

否

Array of strings

指定字段类型的子字段，默认值为“全部”
表6 policy_rule_ids

参数

是否必选

参数类型

描述

policy_id

是

String

参数解释：

策略id，唯一标识一条防护策略.策略id从"查询防护策略列表"(ListPolicy)接口获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

rule_ids

是

Array of strings

参数解释：

规则id数组，包含当前防护策略下的单条规则ID，可通过ListIgnoreRule接口获取规则ID

约束限制：

单条规则ID

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

policy_rule_ids

Array of policy_rule_ids objects

参数解释：

策略和规则id数组，返回防护策略与对应规则的ID关联关系

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表8 policy_rule_ids

参数

参数类型

描述

policy_id

String

参数解释：

策略id，唯一标识一条防护策略

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

rule_ids

Array of strings

参数解释：

规则id数组，返回当前防护策略下的多条规则ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表14 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

批量更新全局白名单规则

POST https://{endpoint}/v1/{project_id}/waf/rule/ignore/batch-update?enterprise_project_id=0

{
  "domain" : [ ],
  "mode" : 1,
  "description" : "",
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "index" : null,
    "contents" : [ "/test" ]
  } ],
  "rule" : "091004",
  "policy_rule_ids" : [ {
    "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
    "policy_id" : "4a34899ab17a4811a6da57742f69135a"
  } ]
}

响应示例

状态码：200

参数解释：

OK

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

{
  "policy_rule_ids" : [ {
    "rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
    "policy_id" : "4a34899ab17a4811a6da57742f69135a"
  } ]
}

SDK代码示例

SDK代码示例如下。

批量更新全局白名单规则

 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
66
67
68
69
70
71
72
73
 
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 BatchUpdateIgnoreRulesSolution {

    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();
        BatchUpdateIgnoreRulesRequest request = new BatchUpdateIgnoreRulesRequest();
        BatchUpdateIgnoreRuleRequestBody body = new BatchUpdateIgnoreRuleRequestBody();
        List<String> listPolicyRuleIdsRuleIds = new ArrayList<>();
        listPolicyRuleIdsRuleIds.add("ed37d85a925d469bb01986d06291d15f");
        List<BatchUpdateIgnoreRuleRequestBodyPolicyRuleIds> listbodyPolicyRuleIds = new ArrayList<>();
        listbodyPolicyRuleIds.add(
            new BatchUpdateIgnoreRuleRequestBodyPolicyRuleIds()
                .withPolicyId("4a34899ab17a4811a6da57742f69135a")
                .withRuleIds(listPolicyRuleIdsRuleIds)
        );
        List<String> listConditionsContents = new ArrayList<>();
        listConditionsContents.add("/test");
        List<CreateCondition> listbodyConditions = new ArrayList<>();
        listbodyConditions.add(
            new CreateCondition()
                .withCategory("url")
                .withContents(listConditionsContents)
                .withLogicOperation("contain")
        );
        body.withPolicyRuleIds(listbodyPolicyRuleIds);
        body.withDescription("");
        body.withRule("091004");
        body.withMode(1);
        body.withConditions(listbodyConditions);
        request.withBody(body);
        try {
            BatchUpdateIgnoreRulesResponse response = client.batchUpdateIgnoreRules(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());
        }
    }
}

批量更新全局白名单规则

 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
 
# 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 = BatchUpdateIgnoreRulesRequest()
        listRuleIdsPolicyRuleIds = [
            "ed37d85a925d469bb01986d06291d15f"
        ]
        listPolicyRuleIdsbody = [
            BatchUpdateIgnoreRuleRequestBodyPolicyRuleIds(
                policy_id="4a34899ab17a4811a6da57742f69135a",
                rule_ids=listRuleIdsPolicyRuleIds
            )
        ]
        listContentsConditions = [
            "/test"
        ]
        listConditionsbody = [
            CreateCondition(
                category="url",
                contents=listContentsConditions,
                logic_operation="contain"
            )
        ]
        request.body = BatchUpdateIgnoreRuleRequestBody(
            policy_rule_ids=listPolicyRuleIdsbody,
            description="",
            rule="091004",
            mode=1,
            conditions=listConditionsbody
        )
        response = client.batch_update_ignore_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

批量更新全局白名单规则

 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 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.BatchUpdateIgnoreRulesRequest{}
	var listRuleIdsPolicyRuleIds = []string{
        "ed37d85a925d469bb01986d06291d15f",
    }
	policyIdPolicyRuleIds:= "4a34899ab17a4811a6da57742f69135a"
	var listPolicyRuleIdsbody = []model.BatchUpdateIgnoreRuleRequestBodyPolicyRuleIds{
        {
            PolicyId: &policyIdPolicyRuleIds,
            RuleIds: &listRuleIdsPolicyRuleIds,
        },
    }
	var listContentsConditions = []string{
        "/test",
    }
	var listConditionsbody = []model.CreateCondition{
        {
            Category: "url",
            Contents: listContentsConditions,
            LogicOperation: "contain",
        },
    }
	descriptionBatchUpdateIgnoreRuleRequestBody:= ""
	request.Body = &model.BatchUpdateIgnoreRuleRequestBody{
		PolicyRuleIds: &listPolicyRuleIdsbody,
		Description: &descriptionBatchUpdateIgnoreRuleRequestBody,
		Rule: "091004",
		Mode: int32(1),
		Conditions: listConditionsbody,
	}
	response, err := client.BatchUpdateIgnoreRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释：

OK

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

400

参数解释：

请求失败

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

401

参数解释：

token权限不足

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

500

参数解释：

服务器内部错误

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

错误码

请参见错误码。

父主题： 策略规则管理

相关文档