CreateAlertRule - 创建自定义监控告警规则_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

创建自定义监控告警规则

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Name	string	是	自定义规则名。	xm_create_test
Owner	string	是	自定义规则的责任人阿里云 UID。	279114181716147735
Enabled	boolean	是	告警规则是否启用。	true
TriggerCondition	object	是	触发告警的条件。
Type	string	否	触发报警的类型，枚举值： Finished: 实例完成 UnFinished: 实例未完成 Error: 实例出错 CycleUnfinished: 实例周期未完成 Timeout: 实例超时 InstanceTransferComplete: 任务转实例完成 InstanceTransferFluctuate: 实例数量波动 ExhaustedError: 自动重跑后仍出错 InstanceKeyword: 出错实例包含关键词 InstanceErrorCount: 出错实例数量 InstanceErrorPercentage: 出错实例占比 ResourceGroupPercentage: 资源组利用率 ResourceGroupWaitCount: 资源组等资源实例数	Error
Extension	object	否	扩展信息，部分触发条件需要配置。
Error	object	否	出错告警配置。
StreamTaskIds	array	否	监控实时计算任务时，填入对应的任务 ID。
	long	否	实时计算任务 ID。	123
AutoRerunAlert	boolean	否	离线任务由于失败自动重跑，是否产生告警。	false
Timeout	object	否	超时告警配置。
TimeoutInMinutes	integer	否	超时时间，单位为分钟，取值范围[1, 21600]。	10
UnFinished	object	否	未完成告警配置。
UnFinishedTime	string	否	未完成时间，格式为 hh:mm，hh 的取值范围为[0,47]，mm 的取值范围为[0,59]。	30:00
CycleUnfinished	object	否	周期未完成告警配置。
CycleAndTime	array<object>	否	周期和时间配置列表。
	object	否
CycleId	integer	否	周期 ID，取值范围为[1,288]。	1
Time	string	否	超时时间，格式为 hh:mm，hh 的取值范围为[0,47]，mm 的取值范围为[0,59]。	12:00
InstanceErrorCount	object	否	实例出错数量告警配置。
Count	integer	否	出错的实例数，取值范围为[1,10000]。	5
InstanceErrorPercentage	object	否	实例出错比例告警配置。
Percentage	integer	否	出错实例百分比，取值范围 [1-100]。	5
InstanceTransferFluctuate	object	否	转实例数量波动告警配置。
Trend	string	否	转实例波动类型，枚举值： abs: 绝对值 increase: 增长 decrease: 下降	abs
Percentage	integer	否	转实例波动百分比，取值范围[1-100]。	10
Target	object	否	监控对象。
Type	string	否	监控对象类型，枚举值： Task: 任务节点 Baseline: 基线 Projec: 工作空间 BizProcess - 业务流程	Task
Ids	array	否	监控对象 ID 列表。
	long	否	监控对象 ID。	123123
AllowTasks	array	否	监控任务白名单列表。
	long	否	监控任务白名单 ID。	123
Notification	object	否	告警通知配置。
SilenceStartTime	string	否	静默开始时间，格式为 HH:mm:ss 。	00:00:00
SilenceEndTime	string	否	静默结束时间，格式为 HH:mm:ss 。	00:00:00
IntervalInMinutes	integer	否	告警间隔，单位为分钟，取值范围[5,10000]。	30
Maximum	integer	否	一个自然日内的告警最大次数，取值范围[1, 10000]。	3
Channels	array	是	告警通道列表。
	string	否	告警通道，枚举值： Mail: 邮件 Phone: 电话 Sms: 短信 Dingding: 钉钉 webhook Feishu: 飞书 webhook Weixin: 企业微信 webhook Webhook: 自定义 Webhook	Sms
Receivers	array<object>	是	告警接收对象。
	object	否
ReceiverType	string	否	告警接收对象类型，枚举值： AliUid: 阿里云 UID ShiftSchedule: 值班表 TaskOwner: 任务责任人，适用于自定义告警和事件告警 Owner: 责任人，适用于基线告警 WebhookUrl: 自定义 webhookUrl DingdingUrl: 钉钉 webhookUrl FeishuUrl: 飞书 webhookUrl WeixinUrl: 企业微信 webhookUrl	TaskOwner
ReceiverValues	array	否	告警接收对象值。
	string	否	告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云 UID，为 ShiftSchedule 时填值班表 ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。	123123123
Extension	string	否	告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。	{"atAll":true}

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID，用于定位日志，排查问题。	A6C6B486-E3A2-5D52-9E76-D9380485D946
Id	long	自定义规则。	123123

示例

正常返回示例

JSON格式

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946\n",
  "Id": 123123
}

错误码

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