GetTLSConfig-查询日志配置--Web应用防火墙-火山引擎

文档中心

立即注册

导航

GetTLSConfig-查询日志配置

最近更新时间：2024.03.01 16:47:38首次发布时间：2023.11.10 18:24:48

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

请求说明

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

请求参数

无

返回参数

参数	类型	示例值	描述
TLSTotal Usage	Integer	`32333882`	已使用日志容量，单位：byte（B）。
TLSTotalCapacity	Integer	`3298534883328`	日志总容量，单位：byte（B）。
AlarmThreshold	Integer	`80`	日志容量告警阈值，为总日志容量的百分比。例如，当告警阈值设置为`80`时，表示当日志存储已使用量级到达日志容量的 80% 时，平台会推送告警通知。
TLSStorageTime	Integer	`180`	日志存储时长，单位：天，范围为 30～3650 天。
ProjectName	String	`waf-project-210005****-cn-beijing`	日志项目名称。
ProjectID	String	`b6fec93d-9b04-44dc-8eb8-969243c9****`	日志项目 ID。
TopicName	String	`waf-log`	日志主题名称。
TopicID	String	`bc5a45b5-9521-4da5-b731-f8c80ad7****`	日志主题 ID。
TLSRegion	String	`cn-beijing`	日志服务所属地域。
DomainList	Array of strings	`["example.volcwaf001.com","example.volcwaf002.com"]`	已选域名采集范围。
TotalDomainList	Array of strings	`["example.volcwaf001.com","example.volcwaf002.com","example.volcwaf003.com"]`	可采集日志的域名范围。
FieldList	FieldList object	-	可选采集字段。
FieldSelectAll	Boolean	`true`	选中全部可选字段。 true：全部选中。 false：未全部选中。
WafActionSelectAll	Boolean	`true`	选中全部处置动作。 true：全部选中。 false：未全部选中。
WafActionList	WafActionList object		可选处置动作。
CapacityAlert	Boolean	`true`	是否启用容量告警。 true：启用。 false：不启用。
CapacityAlertInterval	Integer	`10`	告警间隔时间，单位：天。范围为 1～90 天。

FieldList

参数	类型	示例值	描述
Cookie	Boolean	`true`	采集 Cookie 字段信息。 true：采集。 false：不采集。
RequestBody	Boolean	`true`	采集请求体信息。 true：采集。 false：不采集。
RuleName	Boolean	`true`	采集规则名称。 true：采集。 false：不采集。
RuleDescription	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：不采集。

请求示例

GET https://open.volcengineapi.com/?Action=GetTLSConfig&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***

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202310171658403C054DECDE1C42A35****",
        "Action": "GetTLSConfig",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "TLSTotalUsage": 32333882,
        "TLSTotalCapacity": 3298534883328,
        "AlarmThreshold": 50,
        "TLSStorageTime": 180,
        "ProjectName": "waf-project-210005****-cn-beijing",
        "ProjectID": "b6fec93d-9b04-44dc-8eb8-969243c9****",
        "TopicName": "waf-log",
        "TopicID": "bc5a45b5-9521-4da5-b731-f8c80ad7****",
        "TLSRegion": "cn-beijing",
        "DomainList": [
            "example.volcwaf001.com",
            "example.volcwaf002.com"
        ],
        "TotalDomainList": [
            "example.volcwaf001.com",
            "example.volcwaf002.com"
        ],
        "FieldList": {
            "Cookie": false,
            "RequestBody": false
        },
        "FieldSelectAll": false,
        "WafActionSelectAll": true,
        "WafActionList": {
            "Block": true,
            "HumanVerify": true,
            "HumanVerifyBlock": true,
            "Observe": true,
            "Pass": true
        },
        "CapacityAlert": true,
        "CapacityAlertInterval": 3
    }
}