Query the trend of abnormal response codes with DescribeResponseCodeTrendGraph - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the trends of abnormal response codes, such as 5XX, 405, 499, 302, and 444, returned by WAF to clients and by origin servers to WAF.

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

get

*All Resource

*

acs:ResourceGroupId

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 end time is the current query time.	1665386280
Interval	string	Yes	The time interval. Unit: seconds. The value must be an integer multiple of 60.	300
Type	string	Yes	The type of response codes. Valid values: waf: response codes returned by WAF to clients. upstream: response codes returned by origin servers to WAF.	waf
Resource	string	No	The protected object to query.	www.aliyundoc.com
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf_cdnsdf3****
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 Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7D46493E-84DD-58CE-80A7-8643F2B09ECC
ResponseCodes	array<object>	The response code statistics information.
	object	The response code statistics information.
5xxPv	integer	The count of 5xx response codes.	2932
Index	integer	The time sequence number, sorted in chronological order.	10
405Pv	integer	The count of 405 response codes.	121645464
499Pv	integer	The count of 499 response codes.	0
302Pv	integer	The count of 302 response codes.	0
444Pv	integer	The count of 444 response codes.	0

Examples

Success response

JSON format

{
  "RequestId": "7D46493E-84DD-58CE-80A7-8643F2B09ECC",
  "ResponseCodes": [
    {
      "5xxPv": 2932,
      "Index": 10,
      "405Pv": 121645464,
      "499Pv": 0,
      "302Pv": 0,
      "444Pv": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.