全部產品
Search
文件中心

DataWorks:CreateDIAlarmRule - 建立Data Integration同步任務警示規則

更新時間:Mar 21, 2026

建立Data Integration警示規則。

介面說明

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

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

Description

string

描述。

警示描述

MetricType

string

警示指標類型,可選的枚舉值:

  • Heartbeat(任務狀態警示)

  • FailoverCount(failover 次數警示)

  • Delay(任務延遲警示)

  • DdlReport(DDL 通知)

  • ResourceUtilization(資源群組使用率)

Heartbeat

Enabled

boolean

警示規則是否啟用,預設不開啟。

true

DIJobId

integer

任務 ID,是警示規則關聯的任務 ID。

1

ClientToken

string

等冪參數

ABFUOEUOTRTRJKE

Name

string

警示規則名稱。

alartRule

TriggerConditions

array<object>

警示觸發條件列表,支援多條件。

object

警示觸發條件列表,支援多條件。

Severity

string

嚴重程度,可選的枚舉值:

  • Warning

  • Critical

Warning

Duration

integer

警示計算時間區間,單位分鐘。

10

Threshold

integer

警示閾值。

  • 任務狀態警示:無需填寫閾值。

  • failover 次數警示:閾值為 failover 次數。

  • 任務延遲警示:閾值為延遲時間長度,單位秒。

10

DdlTypes

array

在 DDL 通知的時候才生效,需要生效的 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

Warning

Channels

array

通道,可選的枚舉值:

  • Mail(郵件)

  • Phone(電話)

  • Sms(簡訊)

  • Ding(DingTalk)

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 分鐘。

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"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情