文档

DescribeRuleHitsTopRuleId - 查看命中防护规则的Top 10规则ID

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
StartTimestampstring

查询的开始时间,单位:秒。

1665331200
EndTimestampstring

查询的结束时间,单位:秒。如果不设置该参数,结束时间为当前的查询时间。

1665386280
Resourcestring

防护对象。

www.aliyundoc.com
RuleTypestring

防护对象命中的规则类型。默认不设置该参数,表示显示全部规则。

  • blacklist: 表示命中 IP 黑名单。

  • custom:表示命中自定义规则。

  • antiscan: 表示命中扫描防护规则。

  • cc_system: 表示命中 CC 防护规则。

  • region_block: 表示区域封禁。

blacklist
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
waf_cdnsdf3****
IsGroupResourcestring

规则命中次数是否聚合防护对象。

  • true(默认):表示聚合防护对象的规则命中次数,即只按照单个防护规则命中情况统计次数,当前情况下发返回参数中 Resource 值为空。
  • false:表示不聚合防护对象的规则命中次数,即按照防护对象和防护规则命中情况统计次数。
true
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

F6334274-8870-5D2F-A1AD-D6EF885AC1ED
RuleHitsTopRuleIdobject []

规则 ID 命中 Top10。

Countlong

规则命中请求量。

181174784
Resourcestring

防护对象。当请求参数中 IsGroupResource 为 false 时会返回规则命中的防护对象。

www.aliyundoc.com
RuleIdstring

规则 ID。

5465465

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:IsGroupResource
  • 本页导读 (1)
文档反馈