All Products
Search

This Product

    Web Application Firewall:DescribeUserTraffic

    Document Center

    Web Application Firewall:DescribeUserTraffic

    Last Updated:Mar 31, 2026

    Queries real-time traffic data of different types.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

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

    waf_v3prepaid_public_cn-***

    StartTimestamp

    integer

    No

    The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1665331200
    EndTimestamp

    integer

    No

    The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1665386280
    Type

    string

    No

    The type of real-time traffic that you want to query. Valid values:

    • bot: bot traffic.

    • risk: requests that trigger risk identification.

    • custom_acl_captcha: requests that trigger the CAPTCHA action of a custom rule.

    • qps: the peak queries per second (QPS).

    • apisec: requests that are protected by API security.

    • alb: requests from an Application Load Balancer (ALB) instance.

    • mse: requests from a Microservices Engine (MSE) instance.

    • fc: requests from a Function Compute instance.

    • sae: requests from a Serverless App Engine (SAE) instance.

    • apig: requests from a Cloud-native API Gateway instance.

    • nlb: requests from a Network Load Balancer (NLB) instance.

    qps
    Interval

    integer

    No

    The time interval. Unit: seconds.

    3600
    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
    ResourceManagerResourceGroupId

    string

    No

    The ID of the resource group.

    rg-ae*******i

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    EC10C9EA-A367-52D5-***-***

    UserTraffic

    array<object>

    The list of user traffic data.

    object

    The user traffic data.

    Pv

    integer

    The number of used resources.

    1024
    Index

    integer

    The sequence number of the time interval. The value is sorted in chronological order.

    10

    Examples

    Success response

    JSON format

    {
  "RequestId": "EC10C9EA-A367-52D5-***-***\n",
  "UserTraffic": [
    {
      "Pv": 1024,
      "Index": 10
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.