UpdateDIAlarmRule - DataWorks - Alibaba Cloud Documentation Center

Updates an alert rule configured 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
DIAlarmRuleId	long	Yes	The ID of the alert rule.	34982
Description	string	No	The description of the alert rule.
MetricType	string	No	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
TriggerConditions	array<object>	No	The conditions that can trigger the alert rule.
	object	No	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.	15
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.	5
DdlReportTags	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	ALTERADDCOLUMN
NotificationSettings	object	No	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
InhibitionInterval	long	No	The duration of the alert suppression interval. Default value: 5. Unit: minutes.	5
Name	string	No	The name of the alert rule.	alarm_rule_name
DIJobId	long	No	The ID of the synchronization task.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	A6C6B486-E3A2-5D52-9E76-D9380485D946
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946",
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history