跳转至

nla 数据统计

POST 查询攻击数据

POST /prod-api/waf/nlaV1/statistic/describeAttackData

在指定 时间范围 内查询 攻击/访问趋势 等时序类统计数据。请求体通过 action 声明指标(如 logTread);params 传入统计起止时间;otherFilter 为 对象数组,每一项是一条筛选条件(oneVal / twoVal / threeVal),无筛选时传 []


Body 请求参数

{
  "action": [
    {
      "metricName": "logTread"
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-12 16:49:56",
    "endTime": "2026-05-15 16:49:56"
  }
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string -
body body object -
» action body [object] -
»» metricName body string metricName 统计维度,与返回 data[].metricName 一致;取值见下文「metricName 取值一览」。
»» pageNo body integer(int32) -
»» pageSize body integer(int32) -
» otherFilter body [StatisticOtherFilterVO] 筛选条件 -
»» StatisticOtherFilterVO body StatisticOtherFilterVO StatisticOtherFilterVO -
»»» oneVal body string 搜索名称 见下文「oneVal 常用取值(筛选维度)」。
»»» threeVal body [string] -
»»» twoVal body string 等于或者不等于 eq 等于;ne 不等于;见下文「otherFilter[]」。
» pageNum body integer(int32) 当前页数 -
» pageSize body integer(int32) 每页显示条目个数 -
» params body object -

Body 请求参数字段说明

字段名称 类型 说明
action 数组 要查询的 指标与分页 配置列表;每一项 对应一次独立统计(见下表「action[]」)。
otherFilter 数组 附加筛选条件列表;每一项 为一条筛选条件(见下表「otherFilter[]」)。无筛选时传 []
params 对象 公共查询参数,本接口至少需要统计时间范围(见下表)。

action[](每一项)

字段名称 类型 说明
metricName string 统计维度标识,与返回中 data[].metricName 一致。取值见下表「metricName 取值一览」,须与下表 取值列 完全一致(区分大小写)。
pageNo number 该指标下分页页码(若该指标支持分页),从 1 开始;时序类指标可不传。
pageSize number 该指标下每页条数;时序类指标可不传。
metricName 取值一览

本接口用于 攻击趋势 / 时序曲线 等场景;当前控制台示例为 logTread。返回中 objectArrayList 为 二维数组:每个元素为 [时间戳毫秒, 该时间桶内计数]

metricName 含义说明
logTread 攻击或访问量 时间序列(与控制台攻击趋势图对应);objectArrayList 每项为 [毫秒时间戳, 数值]

otherFilter[](每一项)

otherFilter 为 对象数组:每个元素表示一条筛选条件;多条条件如何组合(与/或)以实现为准。单条元素为如下结构(示例:按套餐 oid 等于 22 过滤):

{
  "oneVal": "oid",
  "twoVal": "eq",
  "threeVal": ["22"]
}

按处置动作筛选时,可将 oneVal 设为 actionthreeVal 为控制台对应的动作取值列表(与前端请求里 oneVal: "action"twoVal: "eq" 的用法一致)。

字段名称 类型 说明
oneVal string 筛选 维度(字段名),如 oid 表示套餐、domain 表示域名等;常用取值见下文「oneVal 常用取值(筛选维度)」。
twoVal string 比较方式:eq 表示等于;ne 表示不等于。
threeVal string[] 比较值 列表,与 oneValtwoVal 搭配使用;多值语义以实现为准。

otherFilter 的完整 Body 示例:

{
  "action": [
    {
      "metricName": "logTread"
    }
  ],
  "otherFilter": [
    {
      "oneVal": "oid",
      "twoVal": "eq",
      "threeVal": ["22"]
    }
  ],
  "params": {
    "beginTime": "2026-05-12 16:49:56",
    "endTime": "2026-05-15 16:49:56"
  }
}

params(时间范围)

字段名称 类型 说明
beginTime string 统计开始时间,格式与示例一致(YYYY-MM-DD HH:mm:ss)。
endTime string 统计结束时间,需不早于 beginTime

oneVal 常用取值(筛选维度)

oneVal 含义
oid 套餐
client_ip 来源 IP
domain 域名
url URL
status 状态码
request_method 请求方法
server_port 端口
ua_os_name 操作系统
ua_name 浏览器
rule_tags 规则标签
client_country_name 国家/地区
client_city_name 城市
waf_acl_id 策略组
rule_Id 规则 ID
action 处置动作

返回示例

200 Response

{
  "msg": "成功",
  "code": 200,
  "data": [
    {
      "metricName": "logTread",
      "objectArrayList": [
        [1778686200000, 3],
        [1778686500000, 0]
      ],
      "total": 146
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK 内联
201 Created Created 无独立数据模型
401 Unauthorized Unauthorized 无独立数据模型
403 Forbidden Forbidden 无独立数据模型
404 Not Found Not Found 无独立数据模型

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
msg string - 提示信息 接口提示文案。
code integer - 状态码 成功示例 200
data [object] - 数据列表 与请求 action[] 对应。
data[].metricName string - 指标名 logTread
data[].objectArrayList [array] - 时序点列表 [时间戳毫秒, 数值][]
data[].total integer - 汇总 该指标总计。

数据模型

Action

{
  "metricName": "string",
  "pageNo": 0,
  "pageSize": 0
}

Action

属性

名称 类型 必选 约束 中文名 说明
metricName string - 指标名 见上文「metricName 取值一览」。
pageNo integer(int32) - 页码 从 1 开始;时序类指标可不传。
pageSize integer(int32) - 每页条数 分页类指标使用;时序类可不传。

DescribeNlaV1StatisticVO

{
  "action": [
    {
      "metricName": "string",
      "pageNo": 0,
      "pageSize": 0
    }
  ],
  "domains": ["string"],
  "interval": "string",
  "otherFilter": [
    {
      "oneVal": "string",
      "threeVal": ["string"],
      "twoVal": "string"
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "params": {},
  "searchHeader": {},
  "terminal": "string",
  "userId": 0
}

DescribeNlaV1StatisticVO

属性

名称 类型 必选 约束 中文名 说明
action [Action] - 指标与分页 每项为 Action;可配置多个指标。
otherFilter [StatisticOtherFilterVO] - 筛选条件 见上文「otherFilter[]」。
pageNum integer(int32) - 当前页数 全局分页;本接口示例以 action / 时序结果为准。
pageSize integer(int32) - 每页条数 同上。
params object - 公共参数 常用:beginTimeendTime

StatisticOtherFilterVO

{
  "oneVal": "string",
  "threeVal": ["string"],
  "twoVal": "string"
}

StatisticOtherFilterVO

属性

名称 类型 必选 约束 中文名 说明
oneVal string - 筛选维度键 取值含义见上文「oneVal 常用取值(筛选维度)」。
twoVal string - 比较方式 eq:等于;ne:不等于。
threeVal [string] - 条件值(多值) oneValtwoVal 组合使用。