Web应用防火墙
Web应用防火墙
文档指南
请输入
- 文档首页
Web应用防火墙API 参考漏洞防护ListVulnerabilityRule - 查询漏洞规则详情
复制全文
下载 pdfListVulnerabilityRule - 查询漏洞规则详情
文档反馈
问问助手查询指定域名下的漏洞防护规则详情，包括规则类型、名称、ID、风险等级等信息。
使用说明
WAF 提供了三种托管防护等级，不同托管防护等级覆盖的检测规则范围不同。您也可以在 WAF 提供的漏洞防护规则范围内，自定义启用不同的漏洞防护规则。
- 托管防护：选择托管防护等级，则默认启用对应防护等级下的所有预置防护规则。规则数量覆盖面：严格>正常>宽松。
- 严格：包含对复杂攻击请求的检测规则，覆盖最多的漏洞防护规则，包含防护等级为正常和宽松的规则。
- 正常：对某类攻击的通用检测或误报较少的规则，包含防护等级为宽松的规则。默认为正常防护等级。
- 宽松：适用于防护攻击特征较为明显的请求，或是希望减少误报的场景。
- 自定义防护：支持在当前内置的漏洞检测规则范围内，自定义开启或关闭对应的规则。
注意事项
- 服务接口调用总上限：1000 QPS
- 单账号调用上限：50 QPS
请求说明
- 请求方式：POST
- 请求地址：https://waf.volcengineapi.com/?Action=ListVulnerabilityRule&Version=2023-12-25
请求参数
Query
Action String 必选 示例值：ListVulnerabilityRule
接口名称。当前 API 的名称为 ListVulnerabilityRule。
Version String 必选 示例值：2023-12-25
接口版本。当前 API 的版本为 2023-12-25。
Body
Host String 可选 示例值：example.volcwaf001.com
对应的防护网站域名。
ProjectName String 可选 示例值：default
RuleMode String 可选 示例值：normal
查询的漏洞规则类别，WAF 将托管规则按严格程度进行分级。
- strict：采用严格模式的漏洞规则。
- normal：采用正常模式的漏洞规则。
- loose：采用宽松模式的漏洞防护规则。
- custom：采用自定义模式的漏洞防护规则，可以对单条漏洞规则进行开启和关闭。
HostAddType Integer 可选 示例值：1
域名的指定方式，默认值为 1。支持的取值如下所示：
- 1：单域名，此时使用 Host 字段指定单个域名；
- 3：域名列表，此时使用 HostList字段指定多域名列表。
HostList String[] 可选 示例值：["a.b.com"]
当HostAddType为3时使用，用于指定多个已接入当前WAF实例的域名，且域名不能重复。
Page Integer 可选 示例值：1
用于指定查询结果的当前页码，默认值为 1。
PageSize Integer 可选 示例值：20
用于指定每页返回的系统漏洞规则数据数量。
返回参数
RuleDetail Object[] 示例值：--
漏洞规则的详细信息。
Accuracy Integer 示例值：85
规则的精确度，数值越高表示误报概率越低。
CVEID String 示例值：CVE-2023-0001
该字段表示漏洞规则关联的 CVE 编号，当规则无关联 CVE 时，返回空字符串。
CustomSystemRuleSwitch Integer 示例值：1
自定义防护等级下的系统规则开关状态。支持的取值如下所示。
- 0：关闭；
- 1：开启。
- 非自定义防护等级时，该字段可能返回 null。
Description String 示例值：用于检测常见 SQL 注入攻击请求
该漏洞防护规则的详细说明，解释规则的功能或检测目标。
Label String[] 示例值：["Ngix"]
规则的标签列表，用于标识规则的属性或分类信息。
RiskLevel Integer 示例值：2
漏洞规则的风险等级。支持的取值如下所示。
- 0：低危；
- 1：中危；
- 2：高危。
RuleID Integer 示例值：10001
系统规则的唯一标识，可用于 UpdateCustomSystemVulRule 接口的 SystemRuleSwitch.RuleID参数。
RuleName String 示例值：SQL 注入防护规则
漏洞防护规则的名称，用于标识具体的防护规则内容。
RuleSetName String 示例值：VulnerabilityScanner
一级规则类别名称：
- CommonDetection：常规检测
- WebBackdoor：Web 后门
- LogicalVulnerability：逻辑漏洞
- VulnerabilityScanner：扫描工具
RuleTag String 示例值：R000000030012
漏洞防护规则的展示 ID，用于外部展示或识别具体规则。
RuleType String 示例值：VulnerabilityScanner
标识漏洞防护规则所属的防护类型，用于区分不同类别的防护规则。
Subcategory String 示例值：OpenSourceScanner
二级规则类别英文名。
UpdateTime String 示例值：2023-10-09T20:02:42Z
规则最近更新时间。
TotalCount Integer 示例值：10
符合查询条件的漏洞规则的总数量。
PageSize Integer 示例值：10
分页查询时，每页包含的系统漏洞规则数据数量。
CurrentPage Integer 示例值：1
分页查询时当前返回的页码。
Count Integer 示例值：1
当前分页返回的系统漏洞规则数据数量。
错误码
输入示例 1
输入示例
POST https://waf.volcengineapi.com/?Action=ListVulnerabilityRule&Version=2023-12-25&ProjectName=default
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
{
"Host": "example.volcwaf001.com",
"HostAddType": 1,
"RuleMode": "normal",
"Page": 1,
"PageSize": 1
}输出示例
{
"ResponseMetadata": {
"RequestId": "20231009200242CE25C146B591DDCE****",
"Action": "ListVulnerabilityRule",
"Version": "2023-12-25",
"Service": "waf",
"Region": "cn-beijing"
},
"Result": {
"RuleDetail": [
{
"Accuracy": 1,
"CVEID": "123456",
"CustomSystemRuleSwitch": 1,
"Description": "FooDescription",
"Label": [
"123456"
],
"RiskLevel": 1,
"RuleID": 1,
"RuleName": "FooName",
"RuleSetName": "FooName",
"RuleTag": "D000000003624",
"RuleType": "123456",
"Subcategory": "123456",
"UpdateTime": "2023-10-09T20:02:42Z"
}
],
"TotalCount": 1,
"PageSize": 1,
"CurrentPage": 1,
"Count": 1
}
}最近更新时间：2026.06.03 17:05:17
这个页面对您有帮助吗？
有用
有用
无用
无用