查询攻击数据¶
1. 接口描述¶
接口请求路径:POST /prod-api/waf/wafv3/statistic/describeAttackData
describeAttackData 用于按时间维度聚合 WAF 访问日志,返回攻击量 / 拦截量趋势时序数据。一次请求可在 action 中声明多个指标,返回的 data 与 action 顺序一一对应;objectArrayList 中每个点为 [毫秒时间戳, 计数]。
仅支持查询最近 180 天内的数据;单次最多查询 30 个域名。Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | Array of Action | 趋势指标列表,不能为空 |
| domains | 否 | Array of String | 域名过滤。空数组或不传表示当前账号全部域名;单次最多 30 个。示例值:[] |
| interval | 否 | String | 时间粒度。取值:1m(1 分钟)、5m(5 分钟)、1h(1 小时)、1d(1 天)。不传时按时间跨度自动选择。示例值:1m |
| otherFilter | 否 | Array of OtherFilter | 附属筛选条件;无筛选时传 [] |
| params | 是 | Params | 查询时间范围 |
| cluster | 否 | String | Elasticsearch 集群名;空或不传时使用 default。示例值:default |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
| data | Array | 指标结果列表,顺序与请求 action 一致 |
| data[].metricName | String | 指标名称。示例值:attack_thread |
| data[].objectArrayList | Array | 时序点列表,每项为 [毫秒时间戳, 数值] |
| data[].total | Integer | 该指标合计请求数。示例值:205 |
4. 示例¶
示例1 查询攻击量与拦截量趋势¶
输入示例¶
{
"action": [
{
"metricName": "attack_thread"
},
{
"metricName": "block_thread"
}
],
"otherFilter": [],
"params": {
"beginTime": "2026-05-20 16:49:02",
"endTime": "2026-05-20 17:49:02"
}
}
代码调用¶
请将 {登录域名}、token 替换为实际值。
curl -X POST 'https://{登录域名}/prod-api/waf/wafv3/statistic/describeAttackData' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
-H 'Content-Type: application/json' \
-d '{
"action": [
{
"metricName": "attack_thread"
},
{
"metricName": "block_thread"
}
],
"otherFilter": [],
"params": {
"beginTime": "2026-05-20 16:49:02",
"endTime": "2026-05-20 17:49:02"
}
}'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class DescribeAttackDataTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/waf/wafv3/statistic/describeAttackData";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"action\":[{\"metricName\":\"attack_thread\"},{\"metricName\":\"block_thread\"}],"
+ "\"otherFilter\":[],"
+ "\"params\":{"
+ "\"beginTime\":\"2026-05-20 16:49:02\","
+ "\"endTime\":\"2026-05-20 17:49:02\""
+ "}"
+ "}";
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("Authorization", "Bearer " + token);
httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
int statusCode = response.getStatusLine().getStatusCode();
String body = EntityUtils.toString(response.getEntity(), "UTF-8");
System.out.println("Status Code: " + statusCode);
System.out.println("Body: " + body);
}
}
}
}
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{登录域名}/prod-api/waf/wafv3/statistic/describeAttackData"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"action": [
{"metricName": "attack_thread"},
{"metricName": "block_thread"}
],
"otherFilter": [],
"params": {
"beginTime": "2026-05-20 16:49:02",
"endTime": "2026-05-20 17:49:02"
}
}`)
req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println("Status Code:", resp.StatusCode)
fmt.Println("Body:", string(body))
}
输出示例¶
{
"msg": "成功",
"code": 200,
"data": [
{
"metricName": "attack_thread",
"objectArrayList": [
[1747738142000, 120],
[1747738202000, 85]
],
"total": 205
},
{
"metricName": "block_thread",
"objectArrayList": [
[1747738142000, 30],
[1747738202000, 12]
],
"total": 42
}
]
}
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 请选择时间范围 | 未传 params 或缺少 beginTime / endTime |
| 只能查询最近180天的数据 | 开始时间超出限制,或时间跨度超过 180 天 |
| 一次性最多查询30个域名 | domains 超过 30 个 |
| 无效的interval | interval 不是支持的粒度 |
| 附属查询条件的条件类型有误 | otherFilter.twoVal 不是支持的比较方式 |
| 查询失败:查询的字段不存在[{0}] | otherFilter.oneVal 不是支持的筛选字段 |
| 查询失败,请确认查询参数是否合法 | 查询执行失败或参数非法 |
6. 数据模型¶
Action¶
action 数组中的单项,声明本次要查询的时序指标。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| metricName | 是 | String | 统计指标。取值:attack_thread(攻击量时间序列)、block_thread(拦截量时间序列,服务端自动追加状态码等于拦截态的筛选)。示例值:attack_thread |
| pageNo | 否 | Integer | 本接口为趋势聚合,分页字段不参与计算。默认值:1。示例值:1 |
| pageSize | 否 | Integer | 本接口为趋势聚合,分页字段不参与计算。默认值:10。示例值:5 |
OtherFilter¶
附属筛选条件。本接口仅支持 eq / ne。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| oneVal | 否 | String | 筛选字段。取值:client_ip(客户端 IP)、http_user_agent(User-Agent)、domain(域名)、url(请求 URI)、status(HTTP 状态码)、request_method(请求方法)、server_port(端口)、ua_os_name(操作系统)、ua_name(浏览器)、client_country_name(国家/地区)、client_city_name(城市)、rule_id(规则 ID)、rule_tags(规则标签)、waf_acl_id(策略组 ID)、request_id(请求 ID)、oid(套餐号)、hostname(主机名)、timezone(时区)。示例值:oid |
| twoVal | 否 | String | 比较方式。取值:eq(等于)、ne(不等于)。示例值:eq |
| threeVal | 否 | Array of String | 比较值列表。示例值:["20240412279097884616"] |
Params¶
查询时间范围。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| beginTime | 是 | String | 开始时间,格式 yyyy-MM-dd HH:mm:ss,仅支持查询最近 180 天。示例值:2026-05-20 16:49:02 |
| endTime | 是 | String | 结束时间,格式 yyyy-MM-dd HH:mm:ss,单次跨度不超过 180 天。示例值:2026-05-20 17:49:02 |