DescribeAlarmBanner - Web Application Firewall - Alibaba Cloud Documentation Center

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 the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-kf74****
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-aek2zerdgm****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5555DC36-0CF2-5AA3-B1C7-D6BD8****
BannerStatus	object	The status information of the alarm banner.
Status	boolean	The alert status. Valid values: true: An alert is active. If the alarm type is sandbox (Type is set to sandbox), this value indicates that the instance is in the sandbox. false: No active alert. If the alarm type is sandbox (Type is set to sandbox), this value indicates that the instance is not in the sandbox.	true
Type	string	The alarm type. Valid value: sandbox: a sandbox alert.	sandbox
Cause	string	The cause of the alert. If the alarm type is sandbox (Type is set to sandbox), valid values are: fivefold: The queries per second (QPS) of your service has exceeded the limit of the current WAF edition. 4count: The actual QPS of your service has exceeded the limit of the current WAF edition. exceed10w: The peak QPS of your service has exceeded 100,000. costProtection: Billing protection is triggered.	4count
Count	integer	The usage at the time of the alert. If the alarm type is sandbox (Type is set to sandbox), this parameter indicates the number of days that usage has exceeded the limit.	9008

Examples

Success response

JSON format

{
  "RequestId": "5555DC36-0CF2-5AA3-B1C7-D6BD8****",
  "BannerStatus": {
    "Status": true,
    "Type": "sandbox",
    "Cause": "4count",
    "Count": 9008
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.