文档中心

Web应用防火墙

漏洞防护

ListVulWhiteField - 查询漏洞加白字段

分页查询指定域名下的漏洞防护加白字段规则，可按 RuleTag 精确查询。

注意事项

服务接口调用总上限：1000 QPS

单账号调用上限：50 QPS

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=ListVulWhiteField&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListVulWhiteField

接口名称。当前 API 的名称为 ListVulWhiteField。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

ProjectName String 可选示例值：default

指定当前资源关联的项目名称，仅可关联当前身份下具有权限的项目。项目名称可通过调用ListProjectResources接口获取。

Host String 可选示例值：example.volcwaf001.com

当HostAddType为1或未传递HostAddType时，用于指定单个域名。

HostAddType Integer 可选示例值：1

域名的指定方式，默认值为 1。支持的取值如下所示：

1：单域名，此时使用 Host 字段指定单个域名；

3：域名列表，此时使用 HostList字段指定多域名列表。

HostList String[] 可选示例值：["a.b.com"]

当HostAddType为3时使用，用于指定多个已接入当前WAF实例的域名，且域名不能重复。

Page Integer 可选示例值：1

指定分页查询时的当前页数，默认值为 1。

PageSize Integer 可选示例值：10

指定分页查询时每页包含的数据数量，默认值为 10。

RuleTag String 可选示例值：R000000010001

规则展示 ID，用于精确查询漏洞防护加白字段规则；若不传该字段，则查询当前域名下全部加白字段规则。

返回参数

Count Integer 示例值：1

当前页返回的漏洞防护加白字段规则数量。

CurrentPage Integer 示例值：1

当前查询结果所在的页码。

Data Object[] 示例值：-

分页查询到的漏洞防护加白字段规则列表。

Enable Integer 示例值：1

漏洞防护加白字段规则的开关状态。支持的取值如下所示。

0：关闭；

1：开启。

FieldArea String 示例值：request.header

漏洞防护加白字段所属的区域：

url：请求 PATH；

args：请求 Query-Arg；

cookies：请求 Cookie；

headers：请求 Header；

bodydetail：请求 body。

FieldList String 示例值：X-Forwarded-For

漏洞防护加白规则中需要加白的具体字段内容，用于指定在漏洞防护检测时忽略检查的字段名称。

Host String 示例值：example.volcwaf001.com

单个域名。当域名指定方式（HostAddType）为 1或未传递时使用。

HostAddType Integer 示例值：1

域名指定方式。支持的取值如下所示。

1：单域名；

3：域名列表。

HostList String[] 示例值：["a.b.com"]

当域名指定方式（HostAddType）为3时使用的多域名列表。

ID Integer 示例值：123456

漏洞防护加白字段规则 ID.

Name String 示例值：VulWhiteFieldName

加白字段规则名称。

RuleTag String 示例值：R000000010001

加白字段规则展示 ID。

UpdateTime String 示例值：2023-10-09T20:02:42Z

最近更新时间。

PageSize Integer 示例值：10

分页查询时每页展示的漏洞防护加白字段规则数量。

TotalCount Integer 示例值：10

满足当前查询条件的漏洞防护加白字段规则的总数量。

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例 2

输入示例

POST https://waf.volcengineapi.com/?Action=ListVulWhiteField&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,
  "HostList": [
    "a.b.com"
  ],
  "Page": 1,
  "PageSize": 1,
  "RuleTag": "R000000010001"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20231009200242CE25C146B591DDCE****",
        "Action": "ListVulWhiteField",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Count": 1,
        "CurrentPage": 1,
        "Data": [
            {
                "Enable": 1,
                "FieldArea": "123456",
                "FieldList": "123456",
                "Host": "a.b.com",
                "HostAddType": 1,
                "HostList": [
                    "123456"
                ],
                "ID": 1,
                "Name": "FooName",
                "RuleTag": "D000000003624",
                "UpdateTime": "2023-10-09T20:02:42Z"
            }
        ],
        "PageSize": 1,
        "TotalCount": 1
    }
}

最近更新时间：2026.06.03 17:05:19

这个页面对您有帮助吗？

有用

无用