文档首页/ Web应用防火墙 WAF/ API参考/ API/ 策略规则管理/ 查询web基础防护内置规则列表
更新时间:2025-08-19 GMT+08:00
分享

查询web基础防护内置规则列表

功能介绍

查询web基础防护内置规则列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/waf/policy/basic-protection/default-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

约束限制:

不涉及

取值范围:

  • 0:代表default企业项目

  • all_granted_eps:代表所有企业项目

  • 其它企业项目ID:长度为36个字符

默认取值:

0

offset

Integer

参数解释:

分页查询的起始位置,表示从第几条记录开始返回(从0开始计数)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

limit

Integer

参数解释:

分页查询的单页返回数量,控制每次请求返回的记录条数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

10

from

Long

参数解释:

起始时间(13位毫秒时间戳),需要和to同时使用。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

to

Long

参数解释:

结束时间(13位毫秒时间戳),需要和from同时使用。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

level

Integer

参数解释:

规则集的防护严格程度。规则集(宽松)下对业务的误报率降低,但漏报率可能会增高;而规则集(严格)下对业务的误报率可能会增高,但漏报率降低。

约束限制:

不涉及

取值范围:

  • 1:宽松

  • 2:中等

  • 3:严格

默认取值:

不涉及

id

String

参数解释:

规则ID,规则的唯一标识。

约束限制:

不涉及

取值范围:

长度为6个字符

默认取值:

不涉及

description

String

参数解释:

规则描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cve_number

String

参数解释:

CVE编号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

risk_level

Integer

参数解释:

危险等级

约束限制:

不涉及

取值范围:

  • 1:高危

  • 2:中危

  • 3:低危

默认取值:

不涉及

protection_type_names

String

参数解释:

防护类型

约束限制:

不涉及

取值范围:

  • vuln:其他

  • xss:跨站脚本

  • cmdi:命令注入

  • lfi:本地文件包含

  • rfi:远程文件包含

  • webshell:网站木马

  • robot:恶意爬虫

  • sqli:SQL注入

默认取值:

不涉及

application_type_names

String

参数解释:

应用类型

约束限制:

不涉及

取值范围:

请参见WAF控制台,Web基础防护规则详情页面的应用类型。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

X-Language

String

参数解释:

语言,默认值为zh-cn。zh-cn(中文)/en-us(英文)。

约束限制:

不涉及

取值范围:

  • zh-cn:中文

  • en-us:英文

  • zh-cn

默认取值:

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

该策略下web基础防护内置规则数量

items

Array of WebBasicProtectionRulesItem objects

web基础防护内置规则数组

表5 WebBasicProtectionRulesItem

参数

参数类型

描述

id

String

参数解释:

规则的ID,规则的唯一标识

取值范围:

不涉及

description

String

参数解释:

规则描述

取值范围:

不涉及

cve_number

String

参数解释:

CVE编号

取值范围:

不涉及

risk_level

Integer

参数解释:

危险等级

  • 1:高危

  • 2:中危

  • 3:低危

  • 1

  • 2

  • 3

取值范围:

application_type

String

参数解释:

应用类型

取值范围:

不涉及

protection_type

String

参数解释:

防护类型

取值范围:

不涉及

effective_time

Integer

参数解释:

生效时间

取值范围:

不涉及

create_time

Integer

参数解释:

创建时间

取值范围:

不涉及

update_time

Integer

参数解释:

更新时间

取值范围:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询项目id为project_id,Web基础防护的规则集详情。

GET https://{endpoint}/v1/{project_id}/waf/policy/basic-protection/default-rules

响应示例

状态码:200

请求成功

{
  "total" : 1,
  "items" : [ {
    "id" : 12298,
    "description" : "利用nmap的命令注入攻击",
    "cve_number" : null,
    "risk_level" : 1,
    "application_type" : null,
    "protection_type" : "cmdi",
    "effective_time" : 0,
    "create_time" : 1618539073821,
    "update_time" : 1749738600000
  } ]
}

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


public class ListWebBasicProtectionRulesSolution {

    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();
        ListWebBasicProtectionRulesRequest request = new ListWebBasicProtectionRulesRequest();
        try {
            ListWebBasicProtectionRulesResponse response = client.listWebBasicProtectionRules(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
# 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 = ListWebBasicProtectionRulesRequest()
        response = client.list_web_basic_protection_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
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.ListWebBasicProtectionRulesRequest{}
	response, err := client.ListWebBasicProtectionRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

相关文档