查询触发的规则

1. 接口描述

接口请求路径：POST /prod-api/waf/nlaV1/statistic/describeTriggeredRules

describeTriggeredRules 用于在指定时间范围内，按自定义规则或策略组统计 HTTP DDoS（NLA）触发量/命中次数，并返回关联明细。一次请求可在 action 中声明多个指标，返回的 data 与 action 顺序一一对应。

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

2. 输入参数

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

参数名称	必选	类型	描述
action	是	Array	统计指标列表，不能为空
action.metricName	是	String	统计维度，支持以下值： rule_Id：按自定义规则统计 acl_id：按策略组（ACL）统计 示例值：rule_Id
action.pageNo	是	Integer	该指标下列表页码，从 1 开始 示例值：1
action.pageSize	是	Integer	该指标下每页条数 示例值：5
domains	否	Array of String	域名过滤。空数组或不传表示当前账号全部域名；单次最多 30 个 示例值：[]
otherFilter	否	Array	附属筛选条件；无筛选时传 []
otherFilter.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
otherFilter.twoVal	否	String	比较方式，支持以下值： eq：等于 ne：不等于 gt：大于 lt：小于 gte：大于等于 lte：小于等于 示例值：eq
otherFilter.threeVal	否	Array of String	比较值列表。范围比较（gt/lt/gte/lte）取首个值 示例值：["22"]
params.beginTime	是	String	开始时间，格式 yyyy-MM-dd HH:mm:ss，仅支持查询最近 180 天 示例值：2026-05-12 15:51:31
params.endTime	是	String	结束时间，格式 yyyy-MM-dd HH:mm:ss，单次跨度不超过 180 天 示例值：2026-05-15 15:51:31

3. 示例

示例1 按规则与策略组查询触发量

输入示例

{
  "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"
  }
}

代码调用

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

JavaGo

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 DescribeTriggeredRulesTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/nlaV1/statistic/describeTriggeredRules";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"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\""
                + "}"
                + "}";

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

    requestBody := []byte(`{
  "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"
  }
}`)

    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": "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": {
            "id": 74,
            "aclName": "酷酷酷",
            "aclStatus": "Off",
            "oid": "20240412279097884616",
            "ownerUid": 279,
            "remark": "12",
            "createTime": "2025-11-13T17:05:00.000+08:00",
            "updateTime": "2026-05-14T15:48:19.000+08:00"
          }
        }
      ],
      "total": 146,
      "termsCount": 1
    }
  ]
}

4. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
data	Array	指标结果列表，顺序与请求 action 一致
data[].metricName	String	指标名称。示例值：rule_Id
data[].list	Array	触发排行列表
data[].list[].id	String	规则 ID 或策略组 ID。示例值：122
data[].list[].value	Integer	触发次数。示例值：146
data[].list[].data	Object	明细对象。rule_Id 为 [TriggeredRuleDetail]；acl_id 为 [TriggeredAclDetail]
data[].total	Integer	该指标合计触发次数。示例值：146
data[].termsCount	Integer	该维度去重项数。示例值：1

5. 错误码

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

6. 数据模型

TriggeredRuleDetail

metricName 为 rule_Id 时，list[].data 的规则明细。

参数名称	类型	描述
ruleId	Integer	规则 ID。示例值：122
ruleMessage	String	规则名称或说明。示例值：人机
group	String	规则分组展示名。示例值：自定义规则
showMatch	Boolean	是否展示匹配细节；可能为 null

TriggeredAclDetail

metricName 为 acl_id 时，list[].data 的策略组明细。策略组已删除时可能仅返回占位名称。

参数名称	类型	描述
id	Integer	策略组 ID。示例值：74
aclName	String	策略组名称。示例值：酷酷酷
aclStatus	String	策略组状态。示例值：Off
oid	String	所属套餐标识
ownerUid	Integer	所属用户 ID
remark	String	备注
createTime	String	创建时间
updateTime	String	更新时间