All Products
Search
Document Center

Web Application Firewall:DescribeAlarmList

Last Updated:Dec 25, 2025

This operation 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The ID of the WAF instance.

Note

Call DescribeInstance to obtain the ID of the WAF instance.

waf_v2_public_cn-pe33e****

RegionId

string

No

The region where the WAF instance is located. 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-aek2ipnu***

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

8D8EBFB7-E1EB-5236-952A-092EDC72***

Alarms

array<object>

A list of alerts.

object

The alert information.

Status

integer

The current status of the alert. Valid values:

  • 1: The queries per second (QPS) usage exceeds the limit.

  • 2: The service is added to the sandbox.

  • 3: The service is removed from the sandbox.

  • 4: The QPS usage returns to normal.

1

Type

string

The alarm type. Valid value:

  • qps: a QPS alert.

qps

MaxQps

integer

The peak QPS.

12000

EndTime

integer

The end time of the alert. This value is a UNIX timestamp in milliseconds.

1605600798

Cause

string

The cause of the alert. Valid values:

  • fivefold: The QPS of the service exceeds the current specifications.

  • 4count: The actual QPS of the service has cumulatively exceeded the current specifications.

  • exceed10w: The peak QPS of the service has exceeded 100,000.

  • costProtection: Billing protection is triggered.

4count

StartTime

integer

The start time of the alert. This value is a UNIX timestamp in 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.