使用CreateAlertRule建立自訂監控警示規則-巨量資料開發治理平台 DataWorks-阿里雲

建立自訂監控警示規則。

調試

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

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
Name	string	是	自訂規則名。	xm_create_test
Owner	string	是	自訂規則的責任人阿里雲 UID。	279114181****
Enabled	boolean	是	警示規則是否啟用。	true
TriggerCondition	object	是	觸發警示的條件。
Type	string	否	觸發警示的類型，枚舉值： Finished: 執行個體完成 UnFinished: 執行個體未完成 Error: 執行個體出錯 CycleUnfinished: 執行個體周期未完成 Timeout: 執行個體逾時 InstanceTransferComplete: 任務轉執行個體完成 InstanceTransferFluctuate: 執行個體數量波動 ExhaustedError: 自動重跑後仍出錯 InstanceKeyword: 出錯執行個體包含關鍵詞 InstanceErrorCount: 出錯執行個體數量 InstanceErrorPercentage: 出錯執行個體佔比 ResourceGroupPercentage: 資源群組利用率 ResourceGroupWaitCount: 資源群組等資源執行個體數	Error
Extension	object	否	擴充資訊，部分觸發條件需要配置。
Error	object	否	出錯警示配置。
StreamTaskIds	array	否	監控Realtime Compute任務時，填入對應的任務 ID。
	integer	否	Realtime Compute任務 ID。	123
AutoRerunAlertEnabled	boolean	否	離線任務由於失敗自動重跑，是否產生警示。	false
Timeout	object	否	逾時警示配置。
TimeoutInMinutes	integer	否	逾時時間，單位為分鐘，取值範圍[1, 21600]。	10
UnFinished	object	否	未完成警示配置。
UnFinishedTime	string	否	未完成時間，格式為 hh:mm，hh 的取值範圍為[0,47]，mm 的取值範圍為[0,59]。	30:00
CycleUnfinished	object	否	周期未完成警示配置。
CycleAndTime	array<object>	否	周期和時間配置列表。
	object	否
CycleId	integer	否	周期 ID，取值範圍為[1,288]。	1
Time	string	否	逾時時間，格式為 hh:mm，hh 的取值範圍為[0,47]，mm 的取值範圍為[0,59]。	12:00
InstanceErrorCount	object	否	執行個體出錯數量警示配置。
Count	integer	否	出錯的執行個體數，取值範圍為[1,10000]。	5
InstanceErrorPercentage	object	否	執行個體出錯比例警示配置。
Percentage	integer	否	出錯執行個體百分比，取值範圍 [1-100]。	5
InstanceTransferFluctuate	object	否	轉執行個體數量波動警示配置。
Trend	string	否	轉執行個體波動類型，枚舉值： abs: 絕對值 increase: 增長 decrease: 下降	abs
Percentage	integer	否	轉執行個體波動百分比，取值範圍[1-100]。	10
Target	object	否	監控對象。
Type	string	否	監控物件類型，枚舉值： Task: 任務節點 Baseline: 基準 Project: 工作空間 BizProcess - 商務程序	Task
Ids	array	否	監控物件識別碼列表。
	integer	否	監控物件識別碼。	123123
AllowTasks	array	否	監控任務白名單列表。
	integer	否	監控任務白名單 ID。	123
Notification	object	否	警示通知配置。
SilenceStartTime	string	否	靜默警示開始時間，格式為 HH:mm。	00:00
SilenceEndTime	string	否	靜默警示結束時間，格式為 HH:mm	00:00
IntervalInMinutes	integer	否	警示間隔，單位為分鐘，取值範圍[5,10000]。	30
Maximum	integer	否	一個自然日內的警示最大次數，取值範圍[1, 10000]。	3
Channels	array	是	警示通道列表。
	string	否	警示通道，枚舉值： Mail: 郵件 Phone: 電話 Sms: 簡訊 Dingding: DingTalk webhook Feishu: 飛書 webhook Weixin: 企業微信 webhook Webhook: 自訂 Webhook	Sms
Receivers	array<object>	是	警示接收對象。
	object	否
ReceiverType	string	否	警示接收物件類型，枚舉值： AliUid: 阿里雲 UID ShiftSchedule: 值班表 TaskOwner: 任務責任人，適用於自訂警示和事件警示 Owner: 責任人，適用於基準警示 WebhookUrl: 自訂 webhookUrl DingdingUrl: DingTalk webhookUrl FeishuUrl: 飛書 webhookUrl WeixinUrl: 企業微信 webhookUrl	TaskOwner
ReceiverValues	array	否	警示接收對象值。
	string	否	警示接收對象值。當 ReceiverType 為 AliUid 時填阿里雲 UID，為 ShiftSchedule 時填值班表 ID，為 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 時填入對應的 URL。	123123123
Extension	string	否	警示對象需要的額外配置，當 ReceiverType 為 DingdingUrl，支援設定 {"atAll":true} @所有人。	{"atAll":true}

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID，用於定位日誌，排查問題。	A6C6B486-E3A2-5D52-9E76-D9380485D946
Id	integer	自訂規則。	123123

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946\n",
  "Id": 123123
}

錯誤碼

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

變更歷史

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