DescribeAlarmList - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a list of alerts.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_v2_public_cn-pe33e****
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: a region outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-aek2ipnu***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8D8EBFB7-E1EB-5236-952A-092EDC72***
Alarms	array<object>	The list of alerts.
	object	The alert information.
Status	integer	The current status of the alert. Valid values: 1: The queries per second (QPS) limit is exceeded. 2: The service enters the sandbox. 3: The service is removed from the sandbox. 4: The QPS no longer exceeds the limit.	1
Type	string	The type of the alert. Valid value: qps: a QPS alert.	qps
MaxQps	integer	The peak QPS.	12000
EndTime	integer	The end time of the alert. This is a UNIX timestamp. Unit: milliseconds.	1605600798
Cause	string	The cause of the alert. Valid values: fivefold: The QPS of your service exceeds the limit of the current specifications. 4count: The actual QPS has cumulatively exceeded the limit of the current specifications. exceed10w: The peak QPS of your service exceeds 100,000. costProtection: Billing protection is triggered.	4count
StartTime	integer	The start time of the alert. This is a UNIX timestamp. Unit: milliseconds.	1605600767
Spec	integer	The current specifications.	10000

Examples

Success response

JSON format

{
  "RequestId": "8D8EBFB7-E1EB-5236-952A-092EDC72***",
  "Alarms": [
    {
      "Status": 1,
      "Type": "qps",
      "MaxQps": 12000,
      "EndTime": 1605600798,
      "Cause": "4count",
      "StartTime": 1605600767,
      "Spec": 10000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.