文档中心

Web应用防火墙

网站设置

BatchUpdateTLSFieldsConfig - 批量更新TLS自定义字段配置

调用 BatchUpdateTLSFieldsConfig 接口，可以批量更新多个防护网站的日志中的 header 字段配置，包括是否记录全部 header 字段，配置例外不需要记录的 header 字段与需要统计分析的 header 字段。

使用说明

记录 header：记录流量中的全部 header 字段。该功能关闭时，日志服务仅记录常见的 header 字段。关于日志字段的详细说明，可参考日志字段说明。

例外 header 字段：指开启记录 Header后，为防止日志存储过大，而设置的不需要记录的 header 字段。

统计 header 字段：设置需要统计、分析和告警的 header 字段。

注意事项

单个实例最多可以配置 100 条统计 header 字段。如果一条字段对多个域名生效，则仅计为一条。

设置为例外 header 字段的字段无法用于统计、分析和告警。

请求说明

请求方式：POST

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

请求参数

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

Query

Action String 必选示例值：BatchUpdateTLSFieldsConfig

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

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

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

Body

DomainList String[] 必选示例值：["test.volcwaf002.com", "test.volcwaf001.com"]

需要更新自定义日志 header 字段配置的域名列表。

ProjectName String 可选示例值：default

当前资源关联的项目名称。项目名称获取方式参考ListProjectResources - 获取项目资源列表。

Region String 必选示例值：cn-beijing

云 WAF 实例所在区域。

华北 2（北京）：cn-beijing

华东 2（上海）：cn-shanghai

华南 1（广州）：cn-guangzhou

亚太东南（柔佛）：ap-southeast-1

TLSFieldsConfig Object 可选示例值：--

日志字段自定义配置。

HeadersConfig Object 可选示例值：--

自定义 header 字段配置。

Enable Integer 可选示例值：1

是否记录全量 HTTP 头部字段。

0：关闭，仅记录常见头部字段；

1：开启，记录全量头部字段，并可配置例外字段和统计字段。

ExcludedKeyList String[] 可选示例值：["X-Sensitive-Data", "Authorization"]

例外 header 字段，将对应字段从字段的 JSON 中排除，可帮助节约日志存储空间。

StatisticalKeyList String[] 可选示例值：["Host", "Content-Length"]

统计 header 字段，将对应字段用于日志统计分析和告警。

返回参数

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

错误码

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

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=BatchUpdateTLSFieldsConfig&Version=2023-12-25

{
    "DomainList": [
        "test.volcwaf002.com",
        "test.volcwaf001.com"
    ],
    "ProjectName": "default",
    "Region": "cn-beijing",
    "TLSFieldsConfig": {
        "HeadersConfig": {
            "Enable": 1,
            "ExcludedKeyList": [
                "X-Sensitive-Data",
                "Authorization"
            ],
            "StatisticalKeyList": [
                "Host",
                "Content-Length"
            ]
        }
    }
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "BatchUpdateTLSFieldsConfig",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    }
}

最近更新时间：2026.01.20 15:17:11

这个页面对您有帮助吗？

有用

无用