DescribeRuleHitsTopRuleId - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the IDs of the top 10 protection rules that are matched by requests.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeRuleHitsTopRuleId	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The beginning of the time range to query. Unit: seconds.	1665331200
EndTimestamp	string	No	The end of the time range to query. 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 rules that are triggered by the protected object. By default, this parameter is not specified and all types of rules are queried. blacklist: IP address blacklist rules. custom: custom rules. antiscan: scan protection rules. cc_system: HTTP flood protection rules. region_block: region blacklist rules.	blacklist
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_cdnsdf3****
IsGroupResource	string	No	Specifies whether protected objects that trigger protection rules are returned in the response. Valid values true: returns only the number of times each protection rule is triggered. If you set IsGroupResource to true, Resource is left empty. false: returns the number of times each protection rule is triggered by each protected object.	true
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	F6334274-8870-5D2F-A1AD-D6EF885AC1ED
RuleHitsTopRuleId	array<object>	The array of the IDs of the top 10 rules that are matched by requests.
RuleHitsTopRuleId	object	The match details of the rule.
Count	long	The number of requests that match the rule.	181174784
Resource	string	The protected object.	www.aliyundoc.com
RuleId	string	The ID of the rule.	5465465

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-27	The request parameters of the API has changed	View Change Details
2023-10-18	The request parameters of the API has changed	View Change Details