文档中心

Web应用防火墙

日志管理

GetTLSConfig - 查询日志配置

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

使用说明

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

您可先参考ListProjectResources - 获取项目资源列表获取项目资源名称，用于查看指定项目下的 WAF 实例日志配置。

如果不传入项目名称参数，则返回账号下所有项目资源中的 WAF 实例日志配置信息。

注意事项

关于日志服务的其他操作，例如检索和下载日志等，可参考日志服务相关接口文档日志管理 API。

日志服务相关 API 暂不支持通过火山 SDK 调用。

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=GetTLSConfig&Version=2023-12-25

请求参数

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

Query

Action String 必选示例值：GetTLSConfig

接口名称。当前 API 的名称为 GetTLSConfig。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

ProjectName String 可选示例值：default

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

项目名称获取方式参考ListProjectResources - 获取项目资源列表。

不传入项目名称参数，则返回账号下所有项目资源中的 WAF 实例日志配置信息。

返回参数

AlarmThreshold Integer 可选示例值：80

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

CapacityAlert Boolean 可选示例值：true

是否启用容量告警。

true：启用。

false：不启用。

CapacityAlertInterval Integer 可选示例值：10

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

DomainList String[] 可选示例值：["example.volcwaf001.com"]

已选域名采集范围。

FieldList Object 可选示例值：--

可选采集字段。

Cookie Boolean 可选示例值：true

采集 Cookie 字段信息。

true：采集。

false：不采集。

RequestBody Boolean 可选示例值：true

采集请求体信息。

true：采集。

false：不采集。

RuleDescription Boolean 可选示例值：true

采集规则描述。

true：采集。

false：不采集。

RuleName Boolean 可选示例值：true

采集规则名称。

true：采集。

false：不采集。

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 String[] 可选示例值：["example.volcwaf001.com"]

可采集日志的域名范围。

WafActionList Object 可选示例值：--

可选处置动作。

AnswerOpt Boolean 可选示例值：true

采集触发“答案优化”动作的日志。

true：采集。

false：不采集。

Block Boolean 可选示例值：true

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

true：采集。

false：不采集。

Drop Boolean 可选示例值：true

采集触发“丢弃”动作的日志。

true：采集。

false：不采集。

HumanVerify Boolean 可选示例值：true

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

true：采集。

false：不采集。

HumanVerifyBlock Boolean 可选示例值：true

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

true：采集。

false：不采集。

JS Boolean 可选示例值：true

采集触发“JS 挑战”动作的日志。

true：采集。

false：不采集。

JSBlock Boolean 可选示例值：true

采集触发“JS 挑战-拦截”动作的日志。

true：采集。

false：不采集。

Observe Boolean 可选示例值：true

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

true：采集。

false：不采集。

Pass Boolean 可选示例值：true

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

true：采集。

false：不采集。

Permit Boolean 可选示例值：true

采集触发“例外”动作的日志。

true：采集。

false：不采集。

Pow Boolean 可选示例值：true

采集触发“工作量证明”动作的日志。

true：采集。

false：不采集。

PowBlock Boolean 可选示例值：true

采集触发“工作量证明-拦截”动作的日志。

true：采集。

false：不采集。

WafActionSelectAll Boolean 可选示例值：true

选中全部处置动作。

true：全部选中。

false：未全部选中。

错误码

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

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=GetTLSConfig&Version=2023-12-25

{
    "ProjectName": "default"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "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,
            "RuleName": true,
            "RequestBody": true,
            "RuleDescription": 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": {
            "JS": true,
            "Pow": true,
            "Drop": true,
            "Pass": true,
            "Block": true,
            "Permit": true,
            "JSBlock": true,
            "Observe": true,
            "PowBlock": true,
            "AnswerOpt": true,
            "HumanVerify": true,
            "HumanVerifyBlock": true
        },
        "WafActionSelectAll": true
    }
}

最近更新时间：2026.01.20 15:17:10

这个页面对您有帮助吗？

有用

无用