文档首页/ 云防火墙 CFW/ API参考/ API/ 访问控制规则管理/ 获取规则的命中次数和最后一次命中时间
更新时间:2025-08-28 GMT+08:00
分享

获取规则的命中次数和最后一次命中时间

功能介绍

获取规则的命中次数和最后一次命中时间

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/cfw/{fw_instance_id}/acl-rule/hit-info/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

rule_ids

Array of strings

参数解释

规则ID,可通过查询防护规则接口查询获得,通过返回值中的data.records.rule_id(.表示各对象之间层级的区分)获得。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

HitStatusResponseData object

参数解释

获取规则的命中次数和最后一次命中时间响应DATA

取值范围

不涉及

表4 HitStatusResponseData

参数

参数类型

描述

records

Array of RuleHitStatusListVO objects

RuleHitStatusListVO

表5 RuleHitStatusListVO

参数

参数类型

描述

rule_id

String

参数解释

规则ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

rule_hit_count

Long

参数解释

规则命中次数

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

rule_last_hit_time

Long

参数解释

命中时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为28f403ddd3f141daa6e046e85cb15519,防火墙ID为bc11e773-35cc-478c-a91c-772ed077e06e下ACL规则的命中次数和最后一次命中时间

https://{Endpoint}/v1/28f403ddd3f141daa6e046e85cb15519/cfw/bc11e773-35cc-478c-a91c-772ed077e06e/acl-rule/hit-info/batch-query

{
  "rule_ids" : [ "323289bf-252d-4f1b-b579-7f20d850e6cc" ]
}

响应示例

状态码:200

OK

{
  "data" : {
    "records" : [ {
      "rule_id" : "93e4e0f8-45b0-42a3-a3f6-09a10943e823",
      "rule_hit_count" : 1,
      "rule_last_hit_time" : 13516541651
    } ]
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档