查询触发的规则¶

1. 接口描述¶

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

describeTriggeredRules 用于统计指定时间范围内触发次数最多的规则 ID 与策略组，用于控制台「触发规则」表格。返回的 list 项除聚合键与次数外，还附带规则/策略组详情对象 data。

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

2. 输入参数¶

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

参数名称	必选	类型	描述
action	是	Array	统计维度列表；一般同时传规则与策略组
action.metricName	是	String	统计维度，支持以下值： `rule_id`：按规则 ID 排行（控制台写法 `rule_Id` 等价） `waf_acl_id`：按策略组 ID（日志字段 `waf_id`）排行示例值：`rule_id`
action.pageNo	是	Integer	页码，从 1 开始示例值：`1`
action.pageSize	是	Integer	每页条数示例值：`5`
domains	否	Array of String	域名过滤；单次最多 30 个示例值：`[]`
otherFilter	否	Array	附属筛选条件；无筛选时传 `[]`
otherFilter.oneVal	否	String	筛选字段，支持以下值： `client_ip`：客户端 IP `domain`：域名 `url`：请求 URI `status`：HTTP 状态码 `oid`：套餐号 `rule_id`：规则 ID `waf_acl_id`：策略组 ID 示例值：`oid`
otherFilter.twoVal	否	String	比较方式，支持以下值： `eq`：等于 `ne`：不等于示例值：`eq`
otherFilter.threeVal	否	Array of String	比较值列表示例值：`["20240412279097884616"]`
params.beginTime	是	String	开始时间，格式 `yyyy-MM-dd HH:mm:ss` 示例值：`2026-05-20 16:57:08`
params.endTime	是	String	结束时间，格式 `yyyy-MM-dd HH:mm:ss` 示例值：`2026-05-20 17:57:08`

3. 示例¶

示例1 查询规则与策略组触发排行¶

输入示例¶

{
  "action": [
    { "metricName": "rule_id", "pageNo": 1, "pageSize": 5 },
    { "metricName": "waf_acl_id", "pageNo": 1, "pageSize": 5 }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-20 16:57:08",
    "endTime": "2026-05-20 17:57:08"
  }
}

代码调用¶

请将 {登录域名}、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/wafv3/statistic/describeTriggeredRules";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"action\":["
                + "{\"metricName\":\"rule_id\",\"pageNo\":1,\"pageSize\":5},"
                + "{\"metricName\":\"waf_acl_id\",\"pageNo\":1,\"pageSize\":5}"
                + "],"
                + "\"otherFilter\":[],"
                + "\"params\":{"
                + "\"beginTime\":\"2026-05-20 16:57:08\","
                + "\"endTime\":\"2026-05-20 17:57:08\""
                + "}"
                + "}";

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

    requestBody := []byte(`{
  "action": [
    {"metricName": "rule_id", "pageNo": 1, "pageSize": 5},
    {"metricName": "waf_acl_id", "pageNo": 1, "pageSize": 5}
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2026-05-20 16:57:08",
    "endTime": "2026-05-20 17:57:08"
  }
}`)

    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": [
        {
          "id": "901234",
          "value": 1280,
          "data": {
            "ruleId": 901234,
            "ruleMessage": "SQL Injection Attack",
            "group": "OWASP CRS",
            "showMatch": true
          }
        }
      ],
      "total": 5000,
      "termsCount": 42
    },
    {
      "metricName": "waf_acl_id",
      "list": [
        {
          "id": "149",
          "value": 3200,
          "data": {
            "id": 149,
            "aclName": "默认策略组",
            "aclStatus": "ON"
          }
        }
      ],
      "total": 5000,
      "termsCount": 3
    }
  ]
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Array	与请求 `action` 顺序对应
data[].metricName	String	`rule_id` 或 `waf_acl_id`
data[].list	Array	当前页触发排行
data[].list[].id	String	聚合键：规则 ID 或策略组 ID
data[].list[].value	Integer	触发次数
data[].list[].data	Object	详情对象；无法匹配库表时仍可能有占位字段
data[].total	Integer	该维度下日志总条数
data[].termsCount	Integer	不同 `id` 个数

当 metricName = rule_id 时，data 常见字段：ruleId、ruleMessage、group、showMatch。

当 metricName = waf_acl_id 时，data 常见字段：id、aclName、aclStatus。

5. 错误码¶

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