Web Application Firewall:DescribePeakTrend - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Retrieves request statistics from a Web Application Firewall (WAF) instance.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The beginning of the time range to query. This value is a UNIX timestamp in seconds.	1665331200
EndTimestamp	string	No	The end of the time range to query. This value is a UNIX timestamp in seconds. If you leave this parameter empty, the current time is used.	1665386340
Interval	string	Yes	The time interval. Unit: seconds. The value must be an integer 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 query the ID of the WAF instance.	waf_cdnsdf3****
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	9D11AC3A-A10C-56E7-A342-E87EC892BAE2
FlowChart	array<object>	The request statistics.
	object	The request statistics at a point in time.
AntiScanSum	integer	The number of requests that are handled by the scan protection module. The value includes requests that are monitored and requests that are blocked.	0
AclSum	integer	The number of requests that are handled by the custom rule (ACL) module. The value includes requests that are monitored and requests that are blocked.	0
WafSum	integer	The number of requests that are handled by the web attack protection module. The value includes requests that are monitored and requests that are blocked.	0
CcSum	integer	The number of requests that are handled by the HTTP flood protection module. The value includes requests that are monitored and requests that are blocked.	0
Index	integer	The sequence number of the time point, in chronological order.	10
Count	integer	The total number of requests.	2622

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.