文档首页/云防火墙 CFW/API参考 (联盟区域) /API/ACL规则管理/获取规则击中次数
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取规则击中次数

功能介绍

获取规则击中次数

URI

POST /v1/{project_id}/acl-rule/count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

表4 请求Body参数

参数

是否必选

参数类型

描述

rule_ids

是

Array of strings

规则id列表，规则id，可通过查询防护规则接口查询获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

data

RuleHitCountRecords object

获取规则击中次数响应数据

表6 RuleHitCountRecords

参数

参数类型

描述

limit

Integer

每页显示个数，范围为1-1024

offset

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

total

Integer

获取规则击中次数总条数

records

Array of RuleHitCountObject objects

规则击中次数信息列表

表7 RuleHitCountObject

参数

参数类型

描述

rule_id

String

规则id

rule_hit_count

Integer

规则击中次数，当acl规则被触发时，对应规则id的击中次数会添加一次。

请求示例

查询项目id为0b2179bbe180d3762fb0c01a2d5725c7中acl规则id为59ff6bd9-0a76-41ec-9650-380086069965的命中次数

https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count

{
  "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ]
}

响应示例

状态码：200

获取规则击中次数响应

{
  "data" : {
    "limit" : 1,
    "offset" : 1,
    "records" : [ {
      "rule_hit_count" : 0,
      "rule_id" : "59ff6bd9-0a76-41ec-9650-380086069965"
    } ],
    "total" : 1
  }
}

状态码

状态码

描述

200

获取规则击中次数响应

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：ACL规则管理