All Products
Search
Document Center

Web Application Firewall:DescribePeakTrend

Last Updated:Apr 23, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribePeakTrendRead
  • 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.

1665386340
IntervalstringYes

The time interval. Unit: seconds. The value must be an integral multiple of 60.

300
ResourcestringNo

The protected object.

www.aliyundoc.com
InstanceIdstringYes

The ID of the 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.

9D11AC3A-A10C-56E7-A342-E87EC892BAE2
FlowChartobject []

An array of the QPS statistics of the WAF instance.

Indexlong

The serial number of the time interval. The serial numbers are arranged in chronological order.

10
AntiScanSumlong

The number of requests that are monitored or blocked by the scan protection module.

0
WafSumlong

The number of requests that are monitored or blocked by the regular expression protection engine.

0
CcSumlong

The number of requests that are monitored or blocked by the HTTP flood protection module.

0
AclSumlong

The number of requests that are monitored or blocked by the custom rule (access control) module.

0
Countlong

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.