調用ListDIAlarmRules擷取Data Integration同步任務警示規則列表-巨量資料開發治理平台 DataWorks-阿里雲

查看Data Integration警示規則。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
JobId	integer	否	任務 ID。	1000001
PageNumber	integer	否	請求的資料頁數，用於翻頁。	1
PageSize	integer	否	每頁顯示的條數，預設為 10 條，最大 100 條。	10
DIAlarmRuleId	integer	否	指定查詢特定的警示規則 ID，如為空白，則查詢 JobId 下的所有警示規則。	34988

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID。用於定位日誌，排查問題。	74C2FECD-5B3A-554A-BCF5-351A36DE9815
PagingInfo	object	分頁資訊
TotalCount	integer	滿足條件的資料總條數。	90
PageNumber	integer	分頁頁碼，從 1 開始。	1
PageSize	integer	每頁顯示的條數	10
DIJobAlarmRules	array<object>	警示規則列表。
	array<object>	單個警示規則詳情。
Id	integer	警示規則 ID。	72402
DIJobId	integer	任務 ID。	32594
Description	string	警示規則描述。	rule descrition
MetricType	string	警示指標類型，可選的枚舉值： Heartbeat（任務狀態警示） FailoverCount（failover 次數警示） Delay（任務延遲警示） DdlReport（DDL 通知） ResourceUtilization（資源群組使用率）	Heartbeat
Name	string	警示規則名稱。	rule_name
Enabled	boolean	警示規則是否啟用。	True
TriggerConditions	array<object>	警示觸發條件列表，支援多條件。
	object	警示觸發條件。
Severity	string	嚴重程度，可選的枚舉值： Warning Critical	Critical
Duration	integer	警示計算時間區間，單位分鐘。	1
Threshold	integer	警示閾值。任務狀態警示：無閾值。 failover 次數警示：閾值為 failover 次數。任務延遲警示：閾值為延遲時間長度，單位秒。	5
DdlTypes	array	在 MetricType 配置為 DdlReport 時才返回需要生效的 DDL 列表。
	string	在 MetricType 配置為 DdlReport 時才返回需要生效的 DDL 列表，包括 AlterAddColumn 加列 AlterDropColumn 刪列 AlterRenameColumn 修改列名 AlterRenameTable 修改表名 AlterTableModify 其他修改表 DropTable 刪除表 TruncateTable 清空表	AlterAddColumn
DdlReportTags `deprecated`	array	該欄位已廢棄，請使用 DdlTypes 欄位
`deprecated`	string	該欄位已廢棄，請使用 DdlTypes 欄位	ALTERADDCOLUMN
NotificationSettings	object	警示通知渠道和接收人設定。
NotificationChannels	array<object>	警示通知渠道數組。
	object	單個警示通知渠道。
Severity	string	嚴重程度，可選的枚舉值： Warning Critical	Critical
Channels	array	警示通道設定數組。
	string	通道，可選的枚舉值; Mail（郵件） Phone（電話） Sms（簡訊） Ding（DingTalk）	Ding
NotificationReceivers	array<object>	警示通知接收方。
	object	警示通知接收方。
ReceiverType	string	接收方類型，取值範圍：AliyunUid/DingToken/FeishuToken/WebHookUrl	DingToken
ReceiverValues	array	接收方取值。當接收方類型為阿里雲 ID 時，接收方取值為具體阿里雲使用者識別碼。當接收方類型為DingTalk token 時，接收方取值為具體DingTalk token 值。
	string	接收方取值。當接收方類型為阿里雲 ID 時，接收方取值為具體阿里雲使用者識別碼。當接收方類型為DingTalk token 時，接收方取值為具體DingTalk token 值。	token1
MuteInterval	integer	警示抑制間隔時間長度，單位分鐘。	5
InhibitionInterval `deprecated`	integer	該欄位已廢棄，請使用 MuteInterval 欄位	5
DIAlarmRuleId `deprecated`	integer	該欄位已廢棄，請使用 Id 欄位。	72402

樣本

正常返回樣本

JSON格式

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "PagingInfo": {
    "TotalCount": 90,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "Id": 72402,
        "DIJobId": 32594,
        "Description": "rule descrition",
        "MetricType": "Heartbeat",
        "Name": "rule_name",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Critical",
            "Duration": 1,
            "Threshold": 5,
            "DdlTypes": [
              "AlterAddColumn"
            ],
            "DdlReportTags": [
              "ALTERADDCOLUMN"
            ]
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Critical",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "MuteInterval": 5,
          "InhibitionInterval": 5
        },
        "DIAlarmRuleId": 72402
      }
    ]
  }
}

錯誤碼

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

變更歷史

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