從DescribeAlertHistoryList遷移到新API - CloudMonitor

調用DescribeAlertHistoryList介面查詢警示歷史詳情。

說明

目前該API介面已標記為棄用，推薦使用替代API：Cms(2019-01-01) - DescribeAlertLogList。

介面說明

本 API 不再維護，推薦您使用 DescribeAlertLogList 。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeAlertHistoryList

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RuleId	string	否	警示規則 ID。關於如何查詢警示規則 ID，請參見 DescribeMetricRuleList 。	applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****
RuleName	string	否	警示規則名稱。關於如何查詢警示規則名稱，請參見 DescribeMetricRuleList 。	ECS_Rule
Namespace	string	否	雲產品的資料命名空間。關於如何查詢雲產品的資料命名空間，請參見雲產品監控項。	acs_ecs_dashboard
MetricName	string	否	雲產品的監控項名稱。關於如何查詢雲產品的監控項名稱，請參見雲產品監控項。	cpu_total
GroupId	string	否	應用分組 ID。關於如何擷取應用分組 ID，請參見 DescribeMonitorGroups 。	7671****
Status	string	否	通道沉默狀態。取值： 2（預設值）：通道沉默。 0：警示或恢複。 1：失效期。	2
State	string	否	警示狀態。取值： ALARM（預設值）：警示狀態。 OK：正常狀態。	ALARM
Ascending	boolean	否	時間排序。取值： true（預設值）：表示時間倒序。 false：表示時間正序。	true
StartTime	string	否	查詢警示歷史的開始時間戳。單位：毫秒。	1640237400000
EndTime	string	否	查詢警示歷史的結束時間戳記。單位：毫秒。	1640608200000
PageSize	integer	否	每頁顯示記錄條數。預設值：10。	10
Page	integer	否	頁碼。預設值：1。	1

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object	無。
Code	string	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The Request is not authorization.
RequestId	string	請求 ID。	C3C69FBE-2262-541F-A409-C52F380BAE63
Total	string	總記錄條數。	2
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
AlarmHistoryList	object
AlarmHistory	array<object>	警示歷史詳情。
	array<object>	警示歷史詳情。
Status	integer	通道沉默狀態。取值： 2（預設值）：通道沉默。 0：警示或恢複。 1：失效期。	2
MetricName	string	監控項名稱。	cpu_total
EvaluationCount	integer	警示重試次數。	3
State	string	警示狀態。取值： ALARM：警示狀態。 OK：正常狀態。	ALARM
Namespace	string	雲端服務的命名空間。	acs_ecs_dashboard
Webhooks	string	URL 回調地址。	https://www.aliyun.com
RuleName	string	警示規則名稱。	ECS_Rule
RuleId	string	警示規則 ID。	applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****
LastTime	integer	警示持續的時間。單位：毫秒。	360133
Value	string	出現警示或警示恢複時的監控值。	10.58
Expression	string	警示觸發的運算式。	$Average>=10
GroupId	string	應用分組 ID。	7671****
AlertTime	integer	警示推送的時間戳記。單位：毫秒。	1640586600000
InstanceName	string	執行個體名稱。	i-bp1cqhiw1za2****
Dimensions	string	警示的資源。	{\"instanceId\":\"i-bp1cqhiw1za2****\"}
Level	string	警示的層級和通知方式。取值： P4：郵件+DingTalk機器人。 OK：無警示。	P4
Contacts	object
Contact	array	警示連絡人。
	string	警示連絡人。	Alice
ContactALIIMs	object
ContactALIIM	array	警示連絡人的WangWang號。說明該參數僅適用於中國站。
	string	警示連絡人的WangWang號。說明該參數僅適用於中國站。	username@example.com
ContactMails	object
ContactMail	array	警示連絡人的郵箱地址。
	string	警示連絡人的郵箱地址。	username@example.com
ContactSmses	object
ContactSms	array	警示連絡人的手機號碼。說明該參數僅適用於中國站。
	string	警示連絡人的手機號碼。說明該參數僅適用於中國站。	13900009999
ContactGroups	object
ContactGroup	array	警示連絡人群組。
	string	警示連絡人群組。	ECS_Group

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "C3C69FBE-2262-541F-A409-C52F380BAE63",
  "Total": "2",
  "Success": true,
  "AlarmHistoryList": {
    "AlarmHistory": [
      {
        "Status": 2,
        "MetricName": "cpu_total",
        "EvaluationCount": 3,
        "State": "ALARM",
        "Namespace": "acs_ecs_dashboard",
        "Webhooks": "https://www.aliyun.com",
        "RuleName": "ECS_Rule",
        "RuleId": "applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****",
        "LastTime": 360133,
        "Value": "10.58",
        "Expression": "$Average>=10",
        "GroupId": "7671****",
        "AlertTime": 1640586600000,
        "InstanceName": "i-bp1cqhiw1za2****",
        "Dimensions": "{\\\"instanceId\\\":\\\"i-bp1cqhiw1za2****\\\"}",
        "Level": "P4",
        "Contacts": {
          "Contact": [
            "Alice"
          ]
        },
        "ContactALIIMs": {
          "ContactALIIM": [
            "username@example.com"
          ]
        },
        "ContactMails": {
          "ContactMail": [
            "username@example.com"
          ]
        },
        "ContactSmses": {
          "ContactSms": [
            "13900009999"
          ]
        },
        "ContactGroups": {
          "ContactGroup": [
            "ECS_Group"
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s
409	%s	%s

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

變更歷史

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