ListDIAlarmRules查詢Data Integration任務的警示規則-巨量資料開發治理平台 DataWorks-阿里雲

查詢Data Integration新版任務警示規則列表，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。

介面說明

當您的任務同步類型中包含即時同步時，支援設定警示規則。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DIJobId	integer	是	任務 ID，是警示規則關聯的任務 ID。	11260
PageNumber	integer	否	頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10。	10

返回參數

名稱	類型	描述	樣本值
	object	響應。
RequestId	string	請求 ID。	74C2FECD-5B3A-554A-BCF5-35****
DIAlarmRulePaging	object	警示規則分頁結果。
TotalCount	integer	總記錄數。	2
PageNumber	integer	頁碼。	1
PageSize	integer	分頁大小。	10
DIJobAlarmRules	array<object>	警示規則列表。
	array<object>	警示規則。
DIAlarmRuleId	integer	警示規則 ID。	41998
DIJobId	integer	任務 ID，是警示規則關聯的任務 ID。	11260
Description	string	描述。	mysql synchronizes to hologres heartbeat alert
MetricType	string	警示指標類型，可選的枚舉值： Heartbeat（任務狀態警示） FailoverCount（failover 次數警示） Delay（任務延遲警示）	Heartbeat
Enabled	boolean	警示規則是否啟用。	true
TriggerConditions	array<object>	警示觸發條件列表，支援多條件。
	object	警示觸發條件。
Severity	string	嚴重程度，可選的枚舉值： Warning Critical	Warning
Duration	integer	警示計算時間區間，單位分鐘。	15
Threshold	integer	警示閾值。任務狀態警示：無閾值。 failover 次數警示：閾值為 failover 次數。任務延遲警示：閾值為延遲時間長度，單位秒。	5
NotificationSettings	object	警示通知設定。
NotificationChannels	array<object>	警示通知渠道，支援多值。
	object	警示通知渠道。
Severity	string	嚴重程度，可選的枚舉值： Warning Critical	Warning
Channels	array	通道列表。
	string	通道，可選的枚舉值： Mail（郵件） Phone（電話） Sms（簡訊） Ding（DingTalk）	Ding
NotificationReceivers	array<object>	警示通知接收方，支援多值。
	object	警示通知接收方。
ReceiverType	string	接收方類型。當警示通知渠道為郵件、電話、簡訊時，接收方類型為阿里雲使用者識別碼（AliyunUid）。當警示通知渠道為DingTalk時，接收方類型為DingTalk token（DingToken）。	DingToken
ReceiverValues	array	接收方取值列表。
	string	接收方取值。當接收方類型為阿里雲 ID 時，接收方取值為具體阿里雲使用者識別碼。當接收方類型為DingTalk token 時，接收方取值為具體DingTalk token 值。	token1
InhibitionInterval	integer	警示抑制間隔時間長度，單位分鐘。	5

樣本

正常返回樣本

JSON格式

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	沒有許可權，請授權
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

變更歷史

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