DescribeAlarmBanner - 查询告警横幅信息 - Web 应用防火墙

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_v3prepaid_public_cn-kf74****
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-aek2zerdgm****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 id。	5555DC36-0CF2-5AA3-B1C7-D6BD8****
BannerStatus	object	告警横幅状态信息。
Status	boolean	告警状态。取值为： true：表示告警中。当告警类型为沙箱（Type 取值为 sandbox）时，表示在沙箱中。 false：表示未告警。当告警类型为沙箱（Type 取值为 sandbox）时，表示未在沙箱中。	true
Type	string	告警类型。取值： sandbox：表示沙箱告警。	sandbox
Cause	string	告警原因。当告警类型为沙箱（Type 取值为 sandbox）时，取值为： fivefold: 表示业务的 QPS 已超过当前规格。 4count：表示实际业务请求数 QPS 已累计超过当前规格。 exceed10w: 表示实际业务请求峰值 QPS 已超过 10 万。 costProtection: 表示触发计费保护。	4count
Count	integer	告警时使用量。当告警类型为沙箱（Type 取值为 sandbox）时，表示超用的天数。	9008

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。