DescribeAlarmList - 擷取WAF 3.0警示並自動化監控 - Web Application Firewall

查詢警示列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeAlarmList

get

*全部資源

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	要操作的 WAF 執行個體 ID。說明您可以調用 DescribeInstance 查詢 WAF 執行個體的 ID。	waf_v2_public_cn-pe33e****
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-aek2ipnu***

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	本次請求的 id。	8D8EBFB7-E1EB-5236-952A-092EDC72***
Alarms	array<object>	警示列表。
	object	警示資訊。
Status	integer	警示目前狀態。取值為： 1：表示 QPS 超用。 2：表示進入沙箱。 3：表示從沙箱移出。 4：表示從 QPS 超用移出。	1
Type	string	警示類型。取值為： qps: 表示業務的 QPS 警示。	qps
MaxQps	integer	QPS 峰值。	12000
EndTime	integer	警示結束時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1605600798
Cause	string	警示原因。取值為： fivefold: 表示業務的 QPS 已超過當前規格。 4count：表示實際業務請求數 QPS 已累計超過當前規格。 exceed10w: 表示實際業務請求峰值 QPS 已超過 10 萬。 costProtection: 表示觸發計費保護。	4count
StartTime	integer	警示開始時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1605600767
Spec	integer	當前規格。	10000

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。