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

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

get

*All Resource

*

acs:ResourceGroupId

None

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 resource group to which the WAF instance belongs.	rg-aek2zerdgm****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5555DC36-0CF2-5AA3-B1C7-D6BD8****
BannerStatus	object	The status information of the alert banner.
Status	boolean	Indicates whether an alert is triggered. Valid values: true: An alert is triggered. If Type is set to sandbox, the instance is in the sandbox. false: No alert is triggered. If Type is set to sandbox, the instance is not in the sandbox.	true
Type	string	The alert type. Valid value: sandbox: a sandbox alert.	sandbox
Cause	string	The cause of the alert. If Type is set to sandbox, valid values: fivefold: The queries per second (QPS) of your service exceeds five times the upper limit of your plan. 4count: The QPS of your service has exceeded the upper limit of your plan for four or more days. exceed10w: The peak QPS of your service exceeds 100,000. costProtection: Billing protection is triggered.	4count
Count	integer	The count associated with the alert at the time it was triggered. If Type is set to sandbox, this parameter indicates the number of days that the QPS has exceeded the upper limit of your plan.	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.