建立Data Integration警示規則。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Description |
string |
否 |
描述。 |
警示描述 |
| MetricType |
string |
是 |
警示指標類型,可選的枚舉值:
|
Heartbeat |
| Enabled |
boolean |
否 |
警示規則是否啟用,預設不開啟。 |
true |
| DIJobId |
integer |
是 |
任務 ID,是警示規則關聯的任務 ID。 |
1 |
| ClientToken |
string |
否 |
等冪參數 |
ABFUOEUOTRTRJKE |
| Name |
string |
是 |
警示規則名稱。 |
alartRule |
| TriggerConditions |
array<object> |
是 |
警示觸發條件列表,支援多條件。 |
|
|
object |
否 |
警示觸發條件列表,支援多條件。 |
||
| Severity |
string |
否 |
嚴重程度,可選的枚舉值:
|
Warning |
| Duration |
integer |
否 |
警示計算時間區間,單位分鐘。 |
10 |
| Threshold |
integer |
否 |
警示閾值。
|
10 |
| DdlTypes |
array |
否 |
在 DDL 通知的時候才生效,需要生效的 DDL 列表。 |
|
|
string |
否 |
在 MetricType 配置為 DdlReport 時才返回需要生效的 DDL 列表,包括
|
AlterAddColumn |
|
DdlReportTags
deprecated
|
array |
否 |
該欄位已廢棄,請使用 DdlTypes 欄位。 |
|
deprecated
|
string |
否 |
該欄位已廢棄,請使用 DdlTypes 欄位。 |
AlterAddColumn |
| NotificationSettings |
object |
是 |
警示通知設定。 |
|
| NotificationChannels |
array<object> |
否 |
警示通知渠道。 |
|
|
object |
否 |
警示通知渠道。 |
||
| Severity |
string |
否 |
嚴重程度,可選的枚舉值:
|
Warning |
| Channels |
array |
否 |
通道,可選的枚舉值:
|
|
|
string |
否 |
通道,可選的枚舉值:
|
Ding |
|
| NotificationReceivers |
array<object> |
否 |
警示通知接收方。 |
|
|
object |
否 |
警示通知接收方。 |
||
| ReceiverType |
string |
否 |
接收方類型,取值範圍:AliyunUid/DingToken/FeishuToken/WebHookUrl |
DingToken |
| ReceiverValues |
array |
否 |
接收方取值。
|
|
|
string |
否 |
接收方取值。
|
token1 |
|
| MuteInterval |
integer |
否 |
警示抑制間隔時間長度,單位分鐘,預設 5 分鐘。 |
5 |
InhibitionInterval
deprecated
|
integer |
否 |
該欄位已廢棄,請使用 MuteInterval 進行配置。 |
5 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| Id |
integer |
警示規則 ID。 |
1 |
| RequestId |
string |
請求的 ID。用於定位日誌,排查問題。 |
C636A747-7E4E-594D-94CD-2B**** |
DIAlarmRuleId
deprecated
|
string |
該欄位已廢棄,請使用 Id 欄位。 |
1 |
樣本
正常返回樣本
JSON格式
{
"Id": 1,
"RequestId": "C636A747-7E4E-594D-94CD-2B****",
"DIAlarmRuleId": "1"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。