You need to enable JavaScript to run this app.
导航
Web应用防火墙
  • 文档首页
    • /Web应用防火墙/API 参考/日志管理/ModifyTLSConfig - 修改日志配置
ModifyTLSConfig - 修改日志配置
最近更新时间：2024.12.03 18:57:40首次发布时间：2023.11.10 18:24:48
我的收藏

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

注意事项

  • 关于日志服务的其他操作，例如检索和下载日志等，可参考日志服务相关接口文档日志管理 API。
  • 日志服务相关 API 暂不支持通过火山 SDK 调用。

请求说明

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

调试

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

请求参数

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

Query

参数
类型
是否必填
示例值
描述
Action
String
是

ModifyTLSConfig

要执行的操作，取值：ModifyTLSConfig。

Version
String
是

2023-12-25

API的版本，取值：2023-12-25。

Body

参数
类型
是否必填
示例值
描述
AlarmThreshold
Integer
否

80

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

CapacityAlert
Boolean
否

true

是否启用容量告警。

  • true：启用。
  • false：不启用。
CapacityAlertInterval
Integer
否

10

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

DomainList
Array of String
否

example.volcwaf001.com

已选域名采集范围。

FieldList
Object
否

可选采集字段。

FieldSelectAll
Boolean
否

true

选中全部可选字段。

  • true：全部选中。
  • false：未全部选中。
TLSStorageTime
Integer
否

180

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

WafActionList
Object
否

可选处置动作。

WafActionSelectAll
Boolean
否

true

选中全部处置动作。

ProjectName
String
否

default

项目名称，即为当前资源关联对应项目，仅可关联当前身份下具有权限的项目。

返回参数

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

请求示例

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

{
  "AlarmThreshold": 80,
  "CapacityAlert": true,
  "CapacityAlertInterval": 10,
  "DomainList": [
    "example.volcwaf001.com"
  ],
  "FieldList": {
    "Cookie": true,
    "RequestBody": true,
    "RuleDescription": true,
    "RuleName": true
  },
  "FieldSelectAll": true,
  "TLSStorageTime": 180,
  "WafActionList": {
    "AnswerOpt": false,
    "Block": true,
    "Drop": false,
    "HumanVerify": true,
    "HumanVerifyBlock": true,
    "JS": true,
    "JSBlock": false,
    "Observe": true,
    "Pass": true,
    "Permit": true,
    "Pow": true,
    "PowBlock": false
  },
  "WafActionSelectAll": true,
  "ProjectName": "default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202411291927592291691281873D8401",
    "Action": "ModifyTLSConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

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