DescribeRuleHitsTopRuleId - 查看命中防护规则的Top 10规则ID - Web 应用防火墙

查看触发防护规则次数最多的前10个规则ID。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeRuleHitsTopRuleId	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
StartTimestamp	string	是	查询的开始时间，单位：秒。	1665331200
EndTimestamp	string	否	查询的结束时间，单位：秒。如果不设置该参数，结束时间为当前的查询时间。	1665386280
Resource	string	否	防护对象。	www.aliyundoc.com
RuleType	string	否	防护对象命中的规则类型。默认不设置该参数，表示显示全部规则。 blacklist: 表示命中 IP 黑名单。 custom：表示命中自定义规则。 antiscan: 表示命中扫描防护规则。 cc_system: 表示命中 CC 防护规则。 region_block: 表示区域封禁。	blacklist
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_cdnsdf3****
IsGroupResource	string	否	规则命中次数是否聚合防护对象。 true（默认）：表示聚合防护对象的规则命中次数，即只按照单个防护规则命中情况统计次数，当前情况下发返回参数中 Resource 值为空。 false：表示不聚合防护对象的规则命中次数，即按照防护对象和防护规则命中情况统计次数。	true
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object	请求结果。
RequestId	string	请求 ID。	F6334274-8870-5D2F-A1AD-D6EF885AC1ED
RuleHitsTopRuleId	array<object>	规则 ID 命中 Top10。
	object	规则 ID 命中情况。
RuleId	string	规则 ID。	5465465
Resource	string	防护对象。当请求参数中 IsGroupResource 为 false 时会返回规则命中的防护对象。	www.aliyundoc.com
Count	long	规则命中请求量。	181174784

示例

正常返回示例

JSON格式

{
  "RequestId": "F6334274-8870-5D2F-A1AD-D6EF885AC1ED",
  "RuleHitsTopRuleId": [
    {
      "RuleId": "5465465",
      "Resource": "www.aliyundoc.com",
      "Count": 181174784
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-27	OpenAPI 入参发生变更	查看变更详情
2023-10-18	OpenAPI 入参发生变更	查看变更详情