All Products
Search

This Product

    Web Application Firewall:DescribeThreatEventTopMetric

    Document Center

    Web Application Firewall:DescribeThreatEventTopMetric

    Last Updated:Jul 06, 2026

    Queries the top 5 statistics of security events aggregated by different statistical objects and sorted in descending order.

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

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Metric

    string

    Yes

    The statistical metric. Different values of Metric correspond to different statistical objects. Valid values:

    • time: aggregates statistics by attack time, sorts them in descending order, and returns the top 5 records.

    • src: aggregates statistics by source IP address of attack requests, sorts them in descending order, and returns the top 5 records.

    • target: aggregates statistics by URL of attack requests (excluding query strings), sorts them in descending order, and returns the top 5 records.

    • type: aggregates statistics by attack type, sorts them in descending order, and returns the top 5 records.

    • tools: aggregates statistics by attack tool, sorts them in descending order, and returns the top 5 records.

    Valid values:

    • src :

      src

    • time :

      time

    • type :

      type

    • tools :

      tools

    • target :

      target

    time
    EventId

    string

    Yes

    The ID of the security event.

    0b7ab137a065aab7656986***11db
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

    You can call DescribeInstance to query the ID of the current WAF instance.

    waf_elasticity-cn-0xldbqt****
    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

    TopMetrics

    array<object>

    The list of statistics.

    object

    The statistics.

    Cnt

    integer

    The number of attacks.

    20
    Value

    string

    The attack value. The meaning of this field varies depending on the value of Metric.

    • If Metric is set to time, this field indicates the attack time.

    • If Metric is set to src, this field indicates the source IP address of the attack.

    • If Metric is set to target, this field indicates the URL of the attack request.

    • If Metric is set to type, this field indicates the attack type. dirscan indicates directory scanning, webscan indicates web scanning, and other attack types are described in the detectType (detection type) parameter of the custom regular rule (regular_custom) in the CreateDefenseRule operation.

    • If Metric is set to tools, this field indicates the attack tool.

    115.28.209.212
    Country

    string

    The country to which the source IP address of the attack belongs.

    Note

    This field returns a meaningful value only when the statistical object (Metric) is set to source IP address (src).

    CN
    Region

    string

    The region to which the source IP address of the attack belongs.

    Note

    This field returns a meaningful value only when the statistical object (Metric) is set to source IP address (src).

    cn-hangzhou
    RequestId

    string

    The request ID.

    12EF3845-CCEB-4B84-AE60-2B49B*****EE5

    Examples

    Success response

    JSON format

    {
  "TopMetrics": [
    {
      "Cnt": 20,
      "Value": "115.28.209.212",
      "Country": "CN",
      "Region": "cn-hangzhou"
    }
  ],
  "RequestId": "12EF3845-CCEB-4B84-AE60-2B49B*****EE5"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.