DescribeRuleHitsTopTuleType - Web Application Firewall - Alibaba Cloud Documentation Center

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:DescribeRuleHitsTopTuleType

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The beginning 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 as the end time.	1665386280
Resource	string	No	The protected object.	www.aliyundoc.com
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note Call the DescribeInstance operation to query the ID of your WAF instance.	waf_cdnsdf3****
RegionId	string	No	The region where the WAF instance is deployed. 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-acfm***q

Response elements

Element	Type	Description	Example
	object	The result of the request.
RequestId	string	The ID of the request.	45E377CE-0B04-578E-B653-EEA63CFE****
RuleHitsTopTuleType	array<object>	The top 10 protection rule types that were hit.
	object	The details about the hits on a protection rule type.
RuleType	string	The type of rule that was hit. This parameter is not returned by default, which indicates that data for all rule types is returned. waf: basic protection rules. blacklist: IP address blacklist. custom: custom rules. antiscan: scan protection rules. cc_system: CC protection rules. region_block: Location Blacklist. scene: bot management. dlp: data leak prevention.	blacklist
Count	integer	The number of requests that hit the rule.	698455

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.