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

获取日志配置信息，包括日志存储容量、告警阈值、存储时长以及采集域名范围等信息。

使用说明

您可通过当前实例所属项目资源，查看其日志配置信息。

  • 您可先参考ListProjectResources - 获取项目资源列表获取项目资源名称，用于查看指定项目下的 WAF 实例日志配置。
  • 如果不传入项目名称参数，则返回账号下所有项目资源中的 WAF 实例日志配置信息。

注意事项

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

请求说明

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

调试

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

请求参数

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

Query

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

GetTLSConfig

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

Version
String
是

2023-12-25

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

Body

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

default

当前资源关联的项目名称。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
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：未全部选中。
ProjectID
String

b6fec93d-9b04-44dc-8eb8-969243c9****

日志项目 ID。

ProjectName
String

waf-project-210005****-cn-beijing

日志项目名称。

TLSRegion
String

cn-beijing

日志服务所属地域。

TLSStorageTime
Integer

180

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

TLSTotalCapacity
Integer

3298534883328

日志总容量，单位：byte（B）。

TLSTotalUsage
Integer

32333882

已使用日志容量，单位：byte（B）。

TopicID
String

bc5a45b5-9521-4da5-b731-f8c80ad7****

日志主题 ID。

TopicName
String

waf-log

日志主题名称。

TotalDomainList
Array of String

["example.volcwaf001.com"]

可采集日志的域名范围。

WafActionList
Object

可选处置动作。

WafActionSelectAll
Boolean

true

选中全部处置动作。

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

请求示例

POST /?Action=GetTLSConfig&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241129T111136Z
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

{
  "ProjectName": "default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241129190815137238079194652F86",
    "Action": "GetTLSConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "AlarmThreshold": 80,
    "CapacityAlert": true,
    "CapacityAlertInterval": 10,
    "DomainList": [
      "example.volcwaf001.com"
    ],
    "FieldList": {
      "Cookie": true,
      "RequestBody": true,
      "RuleDescription": true,
      "RuleName": true
    },
    "FieldSelectAll": true,
    "ProjectID": "b6fec93d-9b04-44dc-8eb8-969243c9****",
    "ProjectName": "waf-project-210005****-cn-beijing",
    "TLSRegion": "cn-beijing",
    "TLSStorageTime": 180,
    "TLSTotalCapacity": 3298534883328,
    "TLSTotalUsage": 32333882,
    "TopicID": "bc5a45b5-9521-4da5-b731-f8c80ad7****",
    "TopicName": "waf-log",
    "TotalDomainList": [
      "example.volcwaf001.com"
    ],
    "WafActionList": {
      "AnswerOpt": false,
      "Block": true,
      "Drop": false,
      "HumanVerify": true,
      "HumanVerifyBlock": true,
      "JS": false,
      "JSBlock": true,
      "Observe": true,
      "Pass": true,
      "Permit": true,
      "Pow": true,
      "PowBlock": true
    },
    "WafActionSelectAll": true
  }
}

错误码

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