DescribePeakTrend - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the queries per second (QPS) statistics of a WAF instance.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribePeakTrend	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The beginning of the time range to query. Unit: seconds.	1665331200
EndTimestamp	string	No	The end of the time range to query. Unit: seconds. If you do not specify this parameter, the current time is used.	1665386340
Interval	string	Yes	The time interval. Unit: seconds. The value must be an integral multiple of 60.	300
Resource	string	No	The protected object.	www.aliyundoc.com
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
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

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	9D11AC3A-A10C-56E7-A342-E87EC892BAE2
FlowChart	array<object>	An array of the QPS statistics of the WAF instance.
FlowChart	object	The QPS statistics of the WAF instance.
Index	long	The serial number of the time interval. The serial numbers are arranged in chronological order.	10
AntiScanSum	long	The number of requests that are monitored or blocked by the scan protection module.	0
WafSum	long	The number of requests that are monitored or blocked by the regular expression protection engine.	0
CcSum	long	The number of requests that are monitored or blocked by the HTTP flood protection module.	0
AclSum	long	The number of requests that are monitored or blocked by the custom rule (access control) module.	0
Count	long	The total number of requests.	2622

Examples

Sample success responses

JSONformat

{
  "RequestId": "9D11AC3A-A10C-56E7-A342-E87EC892BAE2",
  "FlowChart": [
    {
      "Index": 10,
      "AntiScanSum": 0,
      "WafSum": 0,
      "CcSum": 0,
      "AclSum": 0,
      "Count": 2622
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-27	The request parameters of the API has changed	View Change Details