DescribeRuleHitsTopRuleId - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the top 10 rule IDs that are triggered most frequently.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeRuleHitsTopRuleId

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The start of the time range to query. This value is a UNIX timestamp. Unit: seconds.	1665331200
EndTimestamp	string	No	The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the current time is used.	1665386280
Resource	string	No	The protected object.	www.aliyundoc.com
RuleType	string	No	The type of rule that was hit. If you do not specify this parameter, statistics for all rule types are returned. blacklist: The request hit a rule in the IP address blacklist. custom: The request hit a custom rule. antiscan: The request hit a scan protection rule. cc_system: The request hit a CC protection rule. region_block: The request hit a rule in the Location Blacklist.	blacklist
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to obtain the WAF instance ID.	waf_cdnsdf3****
IsGroupResource	string	No	Specifies whether to aggregate the number of rule hits by protected object. true (default): The number of rule hits is aggregated for each protection rule. In this case, the Resource parameter in the response is empty. false: The number of rule hits is not aggregated. Statistics are collected for each protected object and protection rule.	true
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: Outside Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	F6334274-8870-5D2F-A1AD-D6EF885AC1ED
RuleHitsTopRuleId	array<object>	The IDs of the top 10 rules that were hit most frequently.
	object	The details of a rule that was hit.
RuleId	string	The ID of the rule.	5465465
Resource	string	The protected object. This parameter is returned only if IsGroupResource is set to false.	www.aliyundoc.com
Count	integer	The number of times the rule was hit.	181174784

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.