文档中心

Web应用防火墙

漏洞防护

UpdateVulWhiteField - 更新漏洞加白字段规则

更新指定漏洞防护加白字段规则的名称/启用状态/加白字段区域和字段内容。

注意事项

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

单账号调用上限：50 QPS

请求说明

请求方式：POST

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

请求参数

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

Query

Action String 必选示例值：UpdateVulWhiteField

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

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

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

Body

ProjectName String 可选示例值：default

项目名称，即为当前资源关联对应项目，仅可关联当前身份下具有权限的项目。项目名称获取方式参考 ListProjectResources。

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

加白字段的具体内容，需根据 FieldArea指定的请求区域填写对应的字段名或字段列表。

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

当HostAddType为1或未传入HostAddType时使用的单个域名；写接口中需指定该字段，读接口未传入时返回当前账号下匹配条件的域名配置。

HostAddType Integer 可选示例值：1

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

1：单域名；

3：域名列表。

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

多域名列表，当HostAddType取值为3时需提供该字段；数组中的元素为已接入当前WAF实例的域名，且元素不能重复。

ID Integer 必选示例值：123456

漏洞防护加白字段规则 ID，取自 ListVulWhiteField 返回的 Data.ID。

Name String 必选示例值：VulWhiteFieldName

规则名称。

以中文、字母、数字开头

允许字母、数字、中文、点“.”、下划线“_”和中划线“-”

长度为1-128个字符

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

错误码

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

输入示例 1

输入示例 2

输入示例

POST https://waf.volcengineapi.com/?Action=UpdateVulWhiteField&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***

{
  "Enable": 1,
  "FieldArea": "request.header",
  "FieldList": "X-Forwarded-For",
  "Host": "example.volcwaf001.com",
  "HostAddType": 1,
  "ID": 123456,
  "Name": "VulWhiteFieldName"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20231009200242CE25C146B591DDCE****",
        "Action": "UpdateVulWhiteField",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {}
}

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

这个页面对您有帮助吗？

有用

无用