DocsICP FilingConsole
Documentation

UpdateDIAlarmRule

Updated at:
Copy as MD
Product
My Favorites

Updates an alert rule for a data integration synchronization task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
Id

integer

No

The alert rule ID.

34982
Description

string

No

The description of the alert rule.

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. The alert rule is disabled by default.

true
DIJobId

integer

No

The ID of the synchronization task.

1
TriggerConditions

array<object>

No

The trigger conditions for the alert rule.

object

No

A trigger condition for the alert rule.

Severity

string

No

The severity level. Valid values:

  • Warning

  • Critical

Warning
Duration

integer

No

The time interval for alert evaluation. Unit: minutes.

15
Threshold

integer

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
DdlTypes

array

No

The DDL operation types that the alert rule monitors.

string

No

The DDL operation type that the alert rule monitors. Required only when MetricType 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

No

The notification settings for the alert rule.

NotificationChannels

array<object>

No

The notification channels.

object

No

A notification channel configuration.

Severity

string

No

The severity level. Valid values:

  • Warning

  • Critical

Warning
Channels

array

No

The notification channel. Valid values:

  • Mail

  • Phone

  • Sms

  • Ding

string

No

The notification channel. Valid values:

  • Mail

  • Phone

  • Sms

  • Ding

Ding
NotificationReceivers

array<object>

No

The notification recipients.

object

No

A notification recipient configuration.

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 alert suppression interval. Default value: 5. Unit: minutes.

5
InhibitionInterval deprecated

integer

No

This parameter is deprecated and replaced by the MuteInterval parameter.

5
Name

string

No

The name of the alert rule.

alarm_rule_name
DIAlarmRuleId deprecated

integer

No

This parameter is deprecated. Use the Id parameter instead.

34982

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID. You can use the request ID to locate and troubleshoot issues.

A6C6B486-E3A2-5D52-9E76-D9380485D946
Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.