全部产品
Search
文档中心

大数据开发治理平台 DataWorks:CreateRemind - 创建自定义报警规则

更新时间:Nov 15, 2024

调用CreateRemind创建自定义报警规则。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
RemindNamestring

自定义规则的名称,不能超过 128 个字符。

test_error_remind
DndEndstring

免打扰截止时间,格式为 hh:mm。hh 的取值范围为[0,23],mm 的取值范围为[0,59]。

08:00
RemindUnitstring

对象的类型,包括 NODE(任务节点)、BASELINE(基线) 、PROJECT(工作空间)和 BIZPROCESS(业务流程)。

NODE
NodeIdsstring

RemindUnit(对象类型)为 NODE(任务节点)时,监控的任务节点 ID。多个 ID 之间使用英文逗号(,)分隔,一个规则最多监控 50 个节点。

1,2,3
BaselineIdsstring

当 RemindUnit(对象类型)为 BASELINE(基线)时,监控的基线 ID。多个 ID 之间使用英文逗号(,)分隔,一个规则最多监控 5 条基线。

1,2,3
ProjectIdlong

当 RemindUnit(对象类型)为 PROJECT(工作空间)时,监控的工作空间 ID。一个规则只能监控一个工作空间。

9527
BizProcessIdsstring

当 RemindUnit(对象类型)为 BIZPROCESS(业务流程)时,监控的业务流程 ID。多个业务流程 ID 之间使用英文逗号(,)分隔,一个规则最多监控 5 个业务流程。

1,2,3
RemindTypestring

触发条件,包括 FINISHED(完成)、UNFINISHED(未完成)、ERROR(出错)、 CYCLE_UNFINISHED(周期未完成)和 TIMEOUT(运行超时)。

FINISHED
MaxAlertTimesinteger

最大报警次数。最小值为 1,最大值为 10,默认值为 3。

2
AlertIntervalinteger

最小报警间隔,单位为秒。最小值为 1200,默认值为 1800。

1800
Detailstring

不同触发条件的说明如下:

  • 当 RemindType(触发条件)为 FINISHED(完成)时,传空。

  • 当 RemindType(触发条件)为 UNFINISHED(未完成)时,传参格式为{"hour":23,"minu":59}。hour 的取值范围为[0,47],minu 的取值范围为[0,59]。

  • 当 RemindType(触发条件)为 ERROR(出错)时,传空。

  • 当 RemindType(触发条件)为 CYCLE_UNFINISHED(周期未完成)时,传参格式为{"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}。JSON 字符串 key 为周期号,取值范围为[1,288]。value 为该周期对应的未完成时间,格式为 hh:mm。hh 的取值范围为[0,47],mm 的取值范围为[0,59]。

  • 当 RemindType(触发条件)为 TIMEOUT(运行超时)时,传参格式为 1800,单位为秒。即从开始运行起,运行超过 30 分钟触发报警。

{"hour":"23","minu":"59"}
AlertUnitstring

报警接收对象的粒度,包括 OWNER(任务责任人)和 OTHER(指定的人)。

OWNER
AlertMethodsstring

报警方式,取值如下:

  • MAIL:邮件。

  • SMS:短信。 可使用短信告警的地域为:新加坡、马来西亚(吉隆坡)、德国(法兰克福)。

  • Webhooks(企业微信或飞书机器人),仅当配置 Webhooks 参数后,该报警方式才会生效。

  • DINGROBOTS:钉钉群机器人。

多个报警方式之间使用英文逗号(,)分隔。

SMS,MAIL
AlertTargetsstring
  • 当 AlertUnit(报警接收人)为 OWNER(节点任务责任人)时,传空。

  • 当 AlertUnit(报警接收人)为 OTHER(指定的人)时,传入指定用户的阿里云 UID。多个阿里云 UID 之间使用英文逗号(,)分隔,最多支持 10 个。

9527952795279527
RobotUrlsstring

钉钉群机器人的 webhook 地址,多个 webhook 地址之间使用英文逗号(,)分隔。

https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooksstring

企业微信或飞书机器人的 webhook 地址,多个 webhook 地址之间使用英文逗号(,)分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。

仅 DataWorks 企业版支持。 可用地域:华东 2(上海)、西南 1(成都)、华北 3(张家口)、华北 2(北京)、华东 1(杭州)、华南 1(深圳)、中国(香港)、欧洲中部 1(法兰克福)、亚太东南 1(新加坡)。

https://open.feishu.cn/open-apis/bot/v2/hook/*******

返回参数

名称类型描述示例值
object

请求返回结果

HttpStatusCodeinteger

HTTP 返回码。

200
Datalong

创建自定义监控规则成功后,返回的自定义规则 ID。

1234
ErrorMessagestring

错误信息。

The specified parameters are invalid.
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

0000-ABCD-EFG****
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

1031203110005

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 1234,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "ErrorCode": "1031203110005"
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
429Throttling.ResourceYou have reached the limit for the resource. Please contact us by submitting a ticket.-
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.该地域还未开放DataWorks的API服务,请尝试其它地域。
500Forbidden.Wkbench.BaselineNoPermissionYou are not authorized to access the baseline.无对应的基线权限。
500Forbidden.Wkbench.ProjectNoPermissionYou are not authorized to access the workspace.工作空间无权限。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500Forbidden.Wkbench.NoProjectYou have not joined any project.尚未加入任何工作空间。
500Invalid.Wkbench.NodeNotExistThe node does not exist.节点不存在。
500Invalid.Wkbench.BaselineNotExistThe baseline does not exist.基线不存在。
500Forbidden.Wkbench.RemindOverlimitThe maximum number of reminders is exceeded.自定义提醒规则创建超限。

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

变更历史

变更时间变更内容概要操作
暂无变更历史