查询高级监控数据¶
1. 接口描述¶
接口请求路径:POST /prod-api/waf/wafv3/statistic/describeMostData
describeMostData 用于按 WAF 访问日志做多维度 Top 排行统计。一次请求可在 action 中声明多个维度,每个维度独立分页,常用于控制台概览页的 IP、域名、URL、状态码等排行榜。
仅支持查询最近 180 天内的数据;单次最多查询 30 个域名。Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| action | 是 | Array | 统计维度列表,不能为空 |
| action.metricName | 是 | String | 统计维度,支持以下值:client_ip:客户端 IPhttp_user_agent:User-Agentdomain:域名url:请求 URIstatus:HTTP 状态码request_method:请求方法server_port:端口ua_os_name:操作系统ua_name:浏览器rule_tags:规则标签client_country_name:国家/地区client_city_name:城市oid:套餐号attackTimePeriods:攻击时段分布(固定 6 个时段桶,无需分页)示例值: client_ip |
| action.pageNo | 是 | Integer | 页码,从 1 开始。attackTimePeriods 可不传示例值: 1 |
| action.pageSize | 是 | Integer | 每页条数。attackTimePeriods 可不传示例值: 5 |
| domains | 否 | Array of String | 域名过滤;单次最多 30 个 示例值: [] |
| otherFilter | 否 | Array | 附属筛选条件;无筛选时传 [] |
| otherFilter.oneVal | 否 | String | 筛选字段,支持以下值:client_ip:客户端 IPhttp_user_agent:User-Agentdomain:域名url:请求 URIstatus:HTTP 状态码request_method:请求方法server_port:端口ua_os_name:操作系统ua_name:浏览器client_country_name:国家/地区client_city_name:城市rule_id:规则 IDrule_tags:规则标签waf_acl_id:策略组 IDrequest_id:请求 IDoid:套餐号hostname:主机名timezone:时区示例值: oid |
| otherFilter.twoVal | 否 | String | 比较方式,支持以下值:eq:等于ne:不等于示例值: eq |
| otherFilter.threeVal | 否 | Array of String | 比较值列表 示例值: ["20240412279097884616"] |
| params.beginTime | 是 | String | 开始时间,格式 yyyy-MM-dd HH:mm:ss示例值: 2026-05-17 17:40:32 |
| params.endTime | 是 | String | 结束时间,格式 yyyy-MM-dd HH:mm:ss示例值: 2026-05-20 17:40:32 |
3. 示例¶
示例1 查询多维度 Top 排行¶
输入示例¶
{
"action": [
{ "metricName": "client_ip", "pageNo": 1, "pageSize": 5 },
{ "metricName": "domain", "pageNo": 1, "pageSize": 5 }
],
"otherFilter": [
{
"oneVal": "oid",
"twoVal": "eq",
"threeVal": ["20240412279097884616"]
}
],
"params": {
"beginTime": "2026-05-17 17:40:32",
"endTime": "2026-05-20 17:40:32"
}
}
代码调用¶
请将 {登录域名}、token 替换为实际值。
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 DescribeMostDataTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/waf/wafv3/statistic/describeMostData";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"action\":["
+ "{\"metricName\":\"client_ip\",\"pageNo\":1,\"pageSize\":5},"
+ "{\"metricName\":\"domain\",\"pageNo\":1,\"pageSize\":5}"
+ "],"
+ "\"otherFilter\":[{\"oneVal\":\"oid\",\"twoVal\":\"eq\",\"threeVal\":[\"20240412279097884616\"]}],"
+ "\"params\":{"
+ "\"beginTime\":\"2026-05-17 17:40:32\","
+ "\"endTime\":\"2026-05-20 17:40:32\""
+ "}"
+ "}";
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/describeMostData"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"action": [
{"metricName": "client_ip", "pageNo": 1, "pageSize": 5},
{"metricName": "domain", "pageNo": 1, "pageSize": 5}
],
"otherFilter": [
{"oneVal": "oid", "twoVal": "eq", "threeVal": ["20240412279097884616"]}
],
"params": {
"beginTime": "2026-05-17 17:40:32",
"endTime": "2026-05-20 17:40:32"
}
}`)
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": "client_ip",
"list": [
{ "name": "203.0.113.10", "value": 1280 },
{ "name": "198.51.100.2", "value": 640 }
],
"total": 5000,
"termsCount": 42
},
{
"metricName": "domain",
"list": [
{ "name": "www.example.com", "value": 3200 }
],
"total": 5000,
"termsCount": 8
}
]
}
4. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
| data | Array | 与请求 action 顺序对应的统计结果 |
| data[].metricName | String | 指标名称。示例值:client_ip |
| data[].list | Array | 当前页 Top 排行项;每项含 name、value |
| data[].list[].name | String | 维度取值。示例值:203.0.113.10 |
| data[].list[].value | Integer | 命中次数。示例值:1280 |
| data[].total | Integer | 该维度下日志总命中数。示例值:5000 |
| data[].termsCount | Integer | 该维度去重后的桶数量,可用于分页 total。示例值:42 |
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 请选择时间范围 | 未传 params 或缺少 beginTime / endTime |
| 只能查询最近180天的数据 | 开始时间超出限制,或时间跨度超过 180 天 |
| 一次性最多查询30个域名 | domains 超过 30 个 |
| 请输入正确的分页参数 | pageNo / pageSize 非法 |
| 附属查询条件的条件类型有误 | otherFilter.twoVal 不是支持的比较方式 |
| 查询失败,请确认查询参数是否合法 | 查询执行失败或参数非法 |