All Products
Search
Document Center

Web Application Firewall:DescribeRuleHitsTopUa

Last Updated:Nov 15, 2024

Queries the top 10 user agents that are used to initiate attacks.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeRuleHitsTopUaget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestampstringYes

The beginning of the time range to query. Unit: seconds.

1665331200
EndTimestampstringNo

The end of the time range to query. Unit: seconds. If you do not specify this parameter, the current time is used.

1665386280
ResourcestringNo

The protected object.

www.aliyundoc.com
InstanceIdstringYes

The ID of the Web Application Firewall (WAF) instance.

Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.
waf_cdnsdf3****
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q
RegionIdstringNo

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

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The ID of the request.

8E5C7ED7-503A-5986-A005-36F2511EB89F
RuleHitsTopUaarray<object>

The array of the top 10 user agents that are used to initiate attacks.

RuleHitsTopUaobject

The information about the user agent that is used to initiate attacks.

Countlong

The number of attacks that are initiated from the IP address.

531
Uastring

The user agent.

android

Examples

Sample success responses

JSONformat

{
  "RequestId": "8E5C7ED7-503A-5986-A005-36F2511EB89F",
  "RuleHitsTopUa": [
    {
      "Count": 531,
      "Ua": "android"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-27The request parameters of the API has changedView Change Details