更新时间:2024-12-05 GMT+08:00

获取规则击中次数

功能介绍

获取规则击中次数

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目id,用户支持企业项目后,由企业项目生成的id。

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

rule_ids

Array of strings

规则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

规则击中次数

请求示例

查询项目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

错误码

请参见错误码