跳转至

nla 数据统计

POST 查询触发的规则

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

在指定 时间范围 内,按配置的 统计维度(如自定义规则、策略组等)查询 触发量/命中次数 及明细列表。
请求体通过 action 数组声明要查询的 指标类型 与 分页;params 中传入统计起止时间;otherFilter 为 对象数组,每一项是一条筛选条件(oneVal / twoVal / threeVal),无筛选时传 []


Body 请求参数

{
  "action": [
    {
      "metricName": "rule_Id",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "acl_id",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-12 15:51:31",
    "endTime": "2026-05-15 15:51:31"
  }
}

请求参数

名称 类型 必选 约束 中文名 说明
action array - 指标与分页 每项为 Action;可配置多个指标并行查询。
otherFilter array - 筛选条件 每项为一条 oneVal / twoVal / threeVal 条件;见下文「otherFilter[]」。
params object - 公共参数 本接口常用:beginTimeendTime 等时间范围键。

Body 请求参数字段说明

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

action[](每一项)

字段名称 类型 说明
metricName string 统计维度标识。常用:rule_Id — 按 自定义规则 统计;acl_id — 按 策略组(ACL) 统计(与返回中 list[].data 结构对应)。
pageNo number 该指标下列表的分页页码,从 1 开始。
pageSize number 该指标下每页条数。

otherFilter[](每一项)

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

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

otherFilter 的完整 Body 示例(在「无筛选」示例基础上增加筛选):

{
  "action": [
    {
      "metricName": "rule_Id",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [
    {
      "oneVal": "oid",
      "twoVal": "eq",
      "threeVal": ["22"]
    }
  ],
  "params": {
    "beginTime": "2026-05-12 15:51:31",
    "endTime": "2026-05-15 15:51:31"
  }
}

params(时间范围)

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

返回示例

200 Response

{
  "msg": "成功",
  "code": 200,
  "data": [
    {
      "metricName": "rule_Id",
      "list": [
        {
          "value": 146,
          "id": "122",
          "data": {
            "ruleId": 122,
            "ruleMessage": "人机",
            "group": "自定义规则",
            "showMatch": null
          }
        }
      ],
      "total": 146,
      "termsCount": 1
    },
    {
      "metricName": "acl_id",
      "list": [
        {
          "value": 146,
          "id": "74",
          "data": {
            "country": null,
            "searchValue": null,
            "createBy": null,
            "createTime": "2025-11-13T17:05:00.000+08:00",
            "updateBy": null,
            "updateTime": "2026-05-14T15:48:19.000+08:00",
            "remark": "12",
            "params": {},
            "pageNum": null,
            "pageSize": null,
            "id": 74,
            "aclName": "酷酷酷",
            "aclStatus": "Off",
            "oid": "20240412279097884616",
            "ownerUid": 279
          }
        }
      ],
      "total": 146,
      "termsCount": 1
    }
  ]
}

返回结果

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

属性

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

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