CreateDIAlarmRule - DataWorks - Alibaba Cloud Documentation Center

Creates an alert rule for a synchronization task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the alert rule.	The description of the alert rule.
MetricType	string	Yes	The metric type in the alert rule. Valid values: Heartbeat FailoverCount Delay DdlReport ResourceUtilization	Heartbeat
Enabled	boolean	No	Specifies whether to enable the alert rule. By default, the alert rule is disabled.	true
DIJobId	long	Yes	The ID of the synchronization task with which the alert rule is associated.	1
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ABFUOEUOTRTRJKE
Name	string	Yes	The name of the alert rule.	alartRule
TriggerConditions	array<object>	Yes	The conditions that can trigger the alert rule.
	object	Yes	The condition that can trigger the alert rule.
Severity	string	No	The severity level. Valid values: Warning Critical	Warning
Duration	long	No	The time interval for alert calculation. Unit: minutes.	10
Threshold	long	No	The alert threshold. If the alert rule is for task status, you do not need to specify a threshold. If the alert rule is for failovers, you must specify the number of failovers. If the alert rule is for latency, you must specify the latency duration, in seconds.	10
DdlTypes	array	No	The types of DDL operations for which the alert rule takes effect.
	string	No	The type of the DDL operation for which the alert rule takes effect. This parameter is required only if the MetricType parameter is set to DdlReport. Valid values: AlterAddColumn AlterDropColumn AlterRenameColumn AlterRenameTable AlterTableModify DropTable TruncateTable	AlterAddColumn
DdlReportTags`deprecated`	array	No	This parameter is deprecated and replaced by the DdlTypes parameter.
`deprecated`	string	No	This parameter is deprecated and replaced by the DdlTypes parameter.	ALTERADDCOLUMN
NotificationSettings	object	Yes	The alert notification settings.
NotificationChannels	array<object>	No	The alert notification methods.
	object	No	The alert notification method.
Severity	string	No	The severity level. Valid values: Warning Critical	Warning
Channels	array	No	The alert notification method. Valid values: Mail Phone Sms Ding
	string	No	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
NotificationReceivers	array<object>	No	The settings of alert notification recipients.
	object	No	The settings of alert notification recipients.
ReceiverType	string	No	The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.	DingToken
ReceiverValues	array	No	The recipient. If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user. If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.
	string	No	The recipient. If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user. If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.	token1
MuteInterval	integer	No	The duration of the alert suppression interval. Default value: 5. Unit: minutes.	5
InhibitionInterval`deprecated`	integer	No	This parameter is deprecated and replaced by the MuteInterval parameter.	5

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Id	long	The ID of the alert rule.	1
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	C636A747-7E4E-594D-94CD-2B4F8A9A9A63
DIAlarmRuleId`deprecated`	string	This parameter is deprecated and is replaced by the Id parameter.	1

Examples

Sample success responses

JSONformat

{
  "Id": 1,
  "RequestId": "C636A747-7E4E-594D-94CD-2B4F8A9A9A63",
  "DIAlarmRuleId": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-01-09	The internal configuration of the API is changed, but the call is not affected	View Change Details
2025-01-06	The response structure of the API has changed	View Change Details