調用GetAlertMessage API查詢警示資訊詳情-巨量資料開發治理平台 DataWorks-阿里雲

調用GetAlertMessage介面，通過擷取的AlertId查詢警示資訊。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
AlertId	string	是	警示 ID，可調用 ListAlertMessages 擷取。	1421

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID。用於定位日誌，排查問題。	0000-ABCD-EFG****
HttpStatusCode	integer	HTTP 狀態代碼。	200
ErrorMessage	string	錯誤資訊。	The specified parameters are invalid.
ErrorCode	string	錯誤碼。	Invalid.Tenant.ConnectionNotExists
Success	boolean	調用是否成功。取值如下： true：調用成功。 false：調用失敗。	true
Data	object	返回資料詳情。
RemindId	integer	當 Source（警示來源）為 REMIND_ALERT（自訂警示）時，返回觸發的自訂監控規則 ID。	1234
AlertMessageStatus	string	警示資訊的發送狀態。取值如下： READY_TO_SEND（準備發送） SEND_FAIL（發送失敗） SEND_SUCCESS（發送成功） SEND_OVERLIMIT（警示超限）	READY_TO_SEND
AlertUser	string	警示資訊接收人的阿里雲 UID。	9527952795****
AlertTime	integer	警示時間。	1553524393000
AlertMethod	string	警示方式。取值如下： MAIL（郵件） SMS（簡訊） PHONE（電話，僅 DataWorks 專業版及以上版本支援）	SMS
Source	string	警示來源。取值如下： REMIND_ALERT（自訂警示） TOPIC_ALERT（事件警示） SLA_ALERT（基準預警） NODE_CYCLE_ALERT（節點成環警示） NODE_LONELY_ALERT（節點孤立警示）	REMIND_ALERT
Content	string	警示內容。	Node error
RemindName	string	當 Source（警示來源）為 REMIND_ALERT（自訂提醒）時，返回觸發的自訂監控規則名稱。	Custom monitoring rule name
AlertId	integer	警示 ID。	123
Instances	array<object>	當 Source（警示來源）為 REMIND_ALERT（自訂提醒）時，返回觸發自訂監控規則的執行個體列表。其它類型的警示來源返回為空白。
	object	執行個體資訊。
Status	string	執行個體狀態。取值如下： NOT_RUN（未運行） WAIT_TIME（等待時間） WAIT_RESOURCE（等待資源） RUNNING（運行中） CHECKING（校檢中） CHECKING_CONDITION（條件檢測中） FAILURE（運行失敗） SUCCESS（運行成功）	NOT_RUN
InstanceId	integer	執行個體的 ID。	12312****
NodeName	string	節點的名稱。	Node name
NodeId	integer	節點的 ID。	1234
ProjectId	integer	節點所在工作空間的 ID。	1234
Topics	array<object>	當 Source（警示來源）為 TOPIC_ALERT（全域事件警示）時，返回觸發警示的事件列表。當警示來源為其它類型時，返回結果為空白。
	object	事件資訊。
TopicName	string	事件的名稱。	error
InstanceId	integer	事件關聯的執行個體 ID。	12345
TopicId	integer	事件的 ID。	412431
TopicOwner	string	事件責任人的阿里雲 UID。	9527952795****
NodeId	integer	事件關聯的任務節點 ID。	1234
TopicStatus	string	事件的狀態。取值如下： IGNORE（已忽略） NEW（新發現） FIXING（處理中） RECOVER（已恢複）	FIXING
Nodes	array<object>	不同的警示來源返回不同的節點列表：當 Source（警示來源）為 NODE_ CYCLE_ALERT（節點成環警示）時，返回成環的節點類型。當 Source（警示來源）為 NODELONELYALERT（節點孤立警示）時，返回孤立的節點類型。
	object	節點資訊。
Owner	string	節點責任人的阿里雲 UID。	95279527952****
NodeName	string	節點的名稱。	Node name
NodeId	integer	節點的 ID。	1234
ProjectId	integer	節點所在工作空間的 ID。	1234
SlaAlert	object	當 Source（警示來源）為 SLA_ALERT（基準警示）時，返回觸發基準預警的基本執行個體資訊。當警示來源為其它類型時，返回為空白。
Status	string	基準狀態。取值如下： ERROR（異常） SAFE（安全） DANGEROUS（預警） OVER（破線）	SAFE
BaselineOwner	string	基準責任人的阿里雲 UID，多個 UID 之間使用英文逗號（,）分隔。	952795279****
BaselineId	integer	基準的 ID。	15142123
BaselineName	string	基準的名稱。	Baseline name
Bizdate	integer	基準執行個體的業務日期時間戳記。	1553443200000
ProjectId	integer	基準所在工作空間的 ID。	1234
InGroupId	integer	基準執行個體的周期號：Apsara Infrastructure Management Framework線為 1，小時基準範圍為[1,24]。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0000-ABCD-EFG****",
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "RemindId": 1234,
    "AlertMessageStatus": "READY_TO_SEND",
    "AlertUser": "9527952795****",
    "AlertTime": 1553524393000,
    "AlertMethod": "SMS",
    "Source": "REMIND_ALERT",
    "Content": "Node error",
    "RemindName": "Custom monitoring rule name",
    "AlertId": 123,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "InstanceId": 0,
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Topics": [
      {
        "TopicName": "error",
        "InstanceId": 12345,
        "TopicId": 412431,
        "TopicOwner": "9527952795****",
        "NodeId": 1234,
        "TopicStatus": "FIXING"
      }
    ],
    "Nodes": [
      {
        "Owner": "95279527952****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "SlaAlert": {
      "Status": "SAFE",
      "BaselineOwner": "952795279****",
      "BaselineId": 15142123,
      "BaselineName": "Baseline name",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InGroupId": 1
    }
  }
}

錯誤碼

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

變更歷史

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