跳转至

查询高级监控数据

1. 接口描述

接口请求路径:POST /prod-api/waf/nlaV1/statistic/describeMostData

describeMostData 用于查询 HTTP DDoS(NLA)高级监控榜单(按维度聚合的 Top 排行)。一次请求可在 action 中声明多个指标,返回的 dataaction 顺序一一对应;list[].name 为该维度下的展示名或原始值。

仅支持查询最近 180 天内的数据;单次最多查询 30 个域名。Token 获取方式见 密钥鉴权

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
action Array of Action 统计指标列表,不能为空
domains Array of String 域名过滤。空数组或不传表示当前账号全部域名;单次最多 30 个。示例值:[]
otherFilter Array of OtherFilter 附属筛选条件;无筛选时传 []
params Params 查询时间范围

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data Array 指标结果列表,顺序与请求 action 一致
data[].metricName String 指标名称
data[].list Array 排行列表
data[].list[].name String 该维度下的展示名或原始值。示例值:20.197.195.237
data[].list[].value Integer 命中次数。示例值:121
data[].total Integer 该指标合计请求数。示例值:146
data[].termsCount Integer 该维度去重项数(基数估计)。示例值:5

4. 示例

示例1 查询多维度排行

输入示例

{
  "action": [
    {
      "metricName": "oid",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "client_ip",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "http_user_agent",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "domain",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-12 16:49:56",
    "endTime": "2026-05-15 16:49:56"
  }
}

代码调用

请将 {登录域名}token 替换为实际值。

curl -X POST 'https://{登录域名}/prod-api/waf/nlaV1/statistic/describeMostData' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": [
    {
      "metricName": "oid",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "client_ip",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "http_user_agent",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "domain",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-12 16:49:56",
    "endTime": "2026-05-15 16:49:56"
  }
}'
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/nlaV1/statistic/describeMostData";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"action\":["
                + "{\"metricName\":\"oid\",\"pageNo\":1,\"pageSize\":5},"
                + "{\"metricName\":\"client_ip\",\"pageNo\":1,\"pageSize\":5},"
                + "{\"metricName\":\"http_user_agent\",\"pageNo\":1,\"pageSize\":5},"
                + "{\"metricName\":\"domain\",\"pageNo\":1,\"pageSize\":5}"
                + "],"
                + "\"otherFilter\":[],"
                + "\"params\":{"
                + "\"beginTime\":\"2026-05-12 16:49:56\","
                + "\"endTime\":\"2026-05-15 16:49:56\""
                + "}"
                + "}";

        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/nlaV1/statistic/describeMostData"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "action": [
    {"metricName": "oid", "pageNo": 1, "pageSize": 5},
    {"metricName": "client_ip", "pageNo": 1, "pageSize": 5},
    {"metricName": "http_user_agent", "pageNo": 1, "pageSize": 5},
    {"metricName": "domain", "pageNo": 1, "pageSize": 5}
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-12 16:49:56",
    "endTime": "2026-05-15 16:49:56"
  }
}`)

    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": "oid",
      "list": [],
      "total": 0,
      "termsCount": 0
    },
    {
      "metricName": "client_ip",
      "list": [
        { "name": "20.197.195.237", "value": 121 },
        { "name": "142.248.80.72", "value": 17 },
        { "name": "47.251.93.227", "value": 3 },
        { "name": "8.209.96.179", "value": 3 },
        { "name": "35.94.160.85", "value": 2 }
      ],
      "total": 146,
      "termsCount": 5
    },
    {
      "metricName": "http_user_agent",
      "list": [
        { "name": "", "value": 121 },
        { "name": "quic-go HTTP/3", "value": 6 }
      ],
      "total": 146,
      "termsCount": 17
    },
    {
      "metricName": "domain",
      "list": [
        { "name": "example.com", "value": 140 },
        { "name": "38.47.50.157", "value": 3 },
        { "name": "38.47.50.35", "value": 3 }
      ],
      "total": 146,
      "termsCount": 3
    }
  ]
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
请选择时间范围 未传 params 或缺少 beginTime / endTime
只能查询最近180天的数据 开始时间超出限制,或时间跨度超过 180 天
一次性最多查询30个域名 domains 超过 30 个
请输入正确的分页参数 action.pageNo / action.pageSize 缺失或小于 1
附属查询条件的条件类型有误 otherFilter.twoVal 不是支持的比较方式
分数查询条件不能为空 范围比较时 threeVal 为空
查询失败,请确认查询参数是否合法 查询执行失败或参数非法

6. 数据模型

Action

action 数组中的单项,声明统计维度与分页。

参数名称 必选 类型 描述
metricName String 统计维度。取值:oid(套餐)、client_ip(来源 IP)、http_user_agent(User-Agent)、domain(访问域名)、url(URL)、status(HTTP 状态码)、request_method(请求方法)、ua_os_name(操作系统,由 UA 解析)、ua_name(浏览器,由 UA 解析)、client_country_name(国家/地区)、client_city_name(城市)、action(处置动作)、server_port(访问端口)。示例值:client_ip
pageNo Integer 该指标下列表页码,从 1 开始。默认值:1。示例值:1
pageSize Integer 该指标下每页条数。默认值:10。示例值:5

OtherFilter

附属筛选条件。范围比较(gt/lt/gte/lte)取 threeVal 首个值。本接口不支持 contain

参数名称 必选 类型 描述
oneVal String 筛选字段。取值:oid(套餐)、client_ip(来源 IP)、domain(域名)、url(URL)、status(状态码)、request_method(请求方法)、server_port(端口)、ua_os_name(操作系统)、ua_name(浏览器)、client_country_name(国家/地区)、client_city_name(城市)、acl_id(策略组)、rule_Id(规则 ID)、action(处置动作)、bot_score(Bot 评分)、request_id(请求 ID)、hostname(主机名)、timezone(时区)、http_user_agent(User-Agent)。示例值:oid
twoVal String 比较方式。取值:eq(等于)、ne(不等于)、gt(大于)、lt(小于)、gte(大于等于)、lte(小于等于)。示例值:eq
threeVal Array of String 比较值列表。示例值:["22"]

Params

查询时间范围。

参数名称 必选 类型 描述
beginTime String 开始时间,格式 yyyy-MM-dd HH:mm:ss,仅支持查询最近 180 天。示例值:2026-05-12 16:49:56
endTime String 结束时间,格式 yyyy-MM-dd HH:mm:ss,单次跨度不超过 180 天。示例值:2026-05-15 16:49:56