DescribeRuleHitsTopTuleType - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the top 10 protection modules that are matched.

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:DescribeRuleHitsTopTuleType	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The start point of the time period for which to query. Unit: seconds.	1665331200
EndTimestamp	string	No	The end point of the time period for which 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
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****
RegionId	string	No	The ID of the region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aekzwwkpn****5i

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	45E377CE-0B04-578E-B653-EEA63CFE****
RuleHitsTopTuleType	array<object>	The top 10 protection modules that are matched.
RuleHitsTopTuleType	object	The match details of the protection module.
RuleType	string	The type of rule that is matched. By default, this parameter is not returned. This indicates that all types of rules that are matched are returned. waf: basic protection rules. blacklist: IP address blacklist rules. custom: custom rules. antiscan: scan protection rules. cc_system: HTTP flood protection rules. region_block: region blacklist rules. scene: bot management rules. dlp: data leakage prevention rules.	cc_system
Count	long	The number of requests that match protection rules.	698455

Examples

Sample success responses

JSONformat

{
  "RequestId": "45E377CE-0B04-578E-B653-EEA63CFE****",
  "RuleHitsTopTuleType": [
    {
      "RuleType": "cc_system",
      "Count": 698455
    }
  ]
}

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