QueryProtectionOverviewLb - 查询防护概览信息--Web应用防火墙-火山引擎

文档中心

立即注册

导航

QueryProtectionOverviewLb - 查询防护概览信息

最近更新时间：2024.11.21 17:41:55首次发布时间：2023.11.10 18:24:48

查询防护概览信息，包括防护网站数、防护攻击次数和拦截 IP 数。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	QueryProtectionOverviewLb	要执行的操作，取值：QueryProtectionOverviewLb。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
Host	String	否	test.volcwaf001.com	需要查询的域名。如果域名为空，则查询所有域名。
EndTime	Integer	是	1732102677	结束时间，Unix 秒级时间戳。EndTime 要大于 StartTime。
StartTime	Integer	是	1732016277	起始时间，Unix 秒级时间戳。EndTime 要大于 StartTime。

返回参数

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

参数	类型	示例值	描述
AttackCount	Integer	3	防护攻击次数。
AttackIPCount	Integer	3	防护攻击次数。
HostCount	Integer	1	网站数量。如果请求参数 Host 为具体域名，则显示为 1 。如果请求参数 Host 为空，则显示为当前实例下的域名总数。

请求示例

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

{
  "Host": "test.volcwaf001.com",
  "EndTime": 1732102677,
  "StartTime": 1732016277
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241121145017165113176234936A76",
    "Action": "QueryProtectionOverviewLb",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "AttackCount": 3,
    "AttackIPCount": 3,
    "HostCount": 1
  }
}

错误码

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