UpdateDIAlarmRule - 更新数据集成同步任务告警规则_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

更新数据集成报警规则。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:UpdateDIAlarmRule	update	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Id	long	否	告警规则 ID。	34982
Description	string	否	告警规则描述。	告警规则描述。
MetricType	string	否	告警指标类型，可选的枚举值： Heartbeat（任务状态报警） FailoverCount（failover 次数报警） Delay（任务延迟报警） DdlReport: DDL 通知 ResourceUtilization：资源组使用率	Heartbeat
Enabled	boolean	否	告警规则是否启用，默认不开启。	true
DIJobId	long	否	任务 ID。	1
TriggerConditions	array<object>	否	告警触发条件列表，支持多条件。
	object	否	告警触发条件列表，支持多条件。
Severity	string	否	严重程度，可选的枚举值; Warning Critical	Warning
Duration	long	否	告警计算时间区间，单位分钟。	15
Threshold	long	否	告警阈值。任务状态报警：无需填写阈值。 failover 次数报警：阈值为 failover 次数。任务延迟报警：阈值为延迟时长，单位秒。	5
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（钉钉）
	string	否	通道，可选的枚举值： Mail（邮件） Phone（电话） Sms（短信） Ding（钉钉）	Ding
NotificationReceivers	array<object>	否	告警通知接收方。
	object	否	告警通知接收方。
ReceiverType	string	否	接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl	DingToken
ReceiverValues	array	否	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为钉钉 token 时，接收方取值为具体钉钉 token 值。
	string	否	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为钉钉 token 时，接收方取值为具体钉钉 token 值。	token1
MuteInterval	long	否	告警抑制间隔时长，单位分钟，默认 5 分钟。	5
InhibitionInterval`deprecated`	long	否	该字段已废弃，请使用 MuteInterval 进行配置。	5
Name	string	否	告警规则的名称。	alarm_rule_name
DIAlarmRuleId`deprecated`	long	否	该字段已废弃，请使用 Id 字段。	34982

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID。用于定位日志，排查问题。	A6C6B486-E3A2-5D52-9E76-D9380485D946
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败，您可以根据请求 ID 定位具体问题。	true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-01-09	API 内部配置变更，不影响调用	查看变更详情
2025-01-06	API 内部配置变更，不影响调用	查看变更详情
2025-01-06	OpenAPI 入参发生变更	查看变更详情