调用CreateDIAlarmRule创建数据集成同步任务告警规则-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

创建数据集成报警规则。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Description	string	否	描述。	Alert description
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（钉钉）
	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	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"
}

错误码

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

变更历史

更多信息，参考变更详情。