BatchUpdateTLSFieldsConfig - 批量更新TLS自定义字段配置--Web应用防火墙-火山引擎

文档中心

导航

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

最近更新时间：2024.12.10 17:02:12首次发布时间：2024.12.10 17:02:12

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

使用说明

记录 header：记录流量中的全部 header 字段。该功能关闭时，日志服务仅记录常见的 header 字段。关于日志字段的详细说明，可参考日志字段说明。
例外 header 字段：指开启记录 Header后，为防止日志存储过大，而设置的不需要记录的 header 字段。
统计 header 字段：设置需要统计、分析和告警的 header 字段。

注意事项

单个实例最多可以配置 100 条统计 header 字段。如果一条字段对多个域名生效，则仅计为一条。
设置为例外 header 字段的字段无法用于统计、分析和告警。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	BatchUpdateTLSFieldsConfig	要执行的操作，取值：BatchUpdateTLSFieldsConfig。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
DomainList	Array of 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	否	--	日志字段自定义配置。

返回参数

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

请求示例

POST /?Action=BatchUpdateTLSFieldsConfig&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241205T123331Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241205/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241012220621081142216140A5990B",
    "Action": "BatchUpdateTLSFieldsConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

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