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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the WAF instance.	waf_v3prepaid_public_cn-***
StartTimestamp	integer	No	The beginning of the time range to query.	1665331200
EndTimestamp	integer	No	The end of the time range to query.	1665386280
Type	string	No	The type of real-time user traffic. Valid values: bot: the number of bot management requests. risk: the number of times risk identification is triggered. custom_acl_captcha: the number of times the slider action of custom rules is triggered. qps: the peak QPS. apisec: the number of API security requests. alb: the number of requests connected through ALB. mse: the number of requests connected through MSE. fc: the number of requests connected through Function Compute. sae: the number of requests connected through Serverless App Engine. apig: the number of requests connected through Cloud Native API Gateway. nlb: the number of requests connected through NLB.	qps
Interval	integer	No	The time interval. Unit: seconds.	3600
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-ae*******i

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EC10C9EA-A367-52D5-*-*
UserTraffic	array<object>	The list of user traffic data.
	object	The user traffic data.
Pv	integer	The usage.	1024
Index	integer	The sequence number 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.