You need to enable JavaScript to run this app.
导航
Web应用防火墙
  • 文档首页
    • /
  • Web应用防火墙

ModifyTLSConfig-修改日志配置

最近更新时间：2024.03.01 16:53:09

首次发布时间：2023.11.10 18:24:48

我的收藏

修改日志参数配置，例如是否开启容量告警、告警阈值大小，告警时间间隔、日志存储时长以及采集域名和字段范围等。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=ModifyTLSConfig&Version=2020-12-09

请求参数

参数

类型

示例值

是否必填

描述

CapacityAlert

Boolean

true

否

是否启用容量告警。

  • true：启用。
  • false：不启用。

AlarmThreshold

Integer

80

否

日志容量告警阈值，为总日志容量的百分比。例如，当告警阈值设置为80时，表示当日志存储已使用量级到达日志容量的 80% 时，平台会推送告警通知。

CapacityAlertInterval

Integer

10

否

告警间隔时间，单位：天。范围为 1～90 天。

TLSStorageTime

Integer

180

否

日志存储时长，单位：天，范围为 30～3650 天。

WafActionList

WafActionList object

否

可选处置动作。

WafActionSelectAll

Boolean

true

否

选中全部处置动作。

  • true：全部选中。
  • false：未全部选中。

DomainList

Array of strings

["example.volcwaf001.com","example.volcwaf002.com"]

否

已选域名采集范围。

FieldList

FieldList object

-

否

可选采集字段。

FieldSelectAll

Boolean

true

否

选中全部可选字段。

  • true：全部选中。
  • false：未全部选中。

WafActionList

参数

类型

是否必填

示例值

描述

Block

Boolean

否

true

采集触发“拦截”动作的日志。

  • true：采集。
  • false：不采集。

HumanVerify

Boolean

否

true

采集触发“人机验证”动作的日志。

  • true：采集。
  • false：不采集。

HumanVerifyBlock

Boolean

否

true

采集触发“人机验证-拦截”动作的日志。

  • true：采集。
  • false：不采集。

Observe

Boolean

否

true

采集触发“观察”动作的日志。

  • true：采集。
  • false：不采集。

Pass

Boolean

否

true

采集未触发防护规则的访问请求日志。

  • true：采集。
  • false：不采集。

FieldList

参数

类型

是否必填

示例值

描述

Cookie

Boolean

否

true

采集 Cookie 字段信息。

  • true：采集。
  • false：不采集。

RequestBody

Boolean

否

true

采集请求体信息。

  • true：采集。
  • false：不采集。

RuleName

Boolean

否

true

采集规则名称。

  • true：采集。
  • false：不采集。

RuleDescription

Boolean

否

true

采集规则描述。

  • true：采集。
  • false：不采集。

返回参数

无

请求示例

POST https://open.volcengineapi.com/?Action=ModifyTLSConfig&Version=2020-12-09
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "CapacityAlert": true,
  "AlarmThreshold": 60,
  "CapacityAlertInterval": 3,
  "TLSStorageTime": 180,
  "WafActionList": {
    "Pass": true,
    "Observe": true,
    "Block": false,
    "HumanVerify": true,
    "HumanVerifyBlock": true
  },
  "WafActionSelectAll": false,
  "DomainList": [
    "example.volcwaf001.com",
    "example.volcwaf002.com"
  ],
  "FieldList": {
    "Cookie": true,
    "RequestBody": false,
    "RuleName": false,
    "RuleDescription": true
  },
  "FieldSelectAll": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202310171656233C054DECDE1C42A3****",
        "Action": "ModifyTLSConfig",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": null
}