AI 助理
文档备案控制台
官方文档
首页

UpdateRemind - 更新自定义报警规则

更新时间：
复制 MD 格式
产品详情
我的收藏

调用UpdateRemind更新自定义监控规则。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
RemindId

integer

是

自定义规则的 ID。

1234
RemindName

string

否

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

update_remindname
DndEnd

string

否

免打扰的截止时间，即在设置的时间之前不会发送报警。格式为 hh:mm。hh 的取值范围为[0,23] ，mm 的取值范围为[0,59]。

08:00
RemindUnit

string

否

监控对象的类型。取值如下：

  • NODE（节点）

  • BASELINE（基线）

  • PROJECT（工作空间）

  • BIZPROCESS（业务流程）

枚举值：

  • BASELINE :

    基线

  • PROJECT :

    工作空间

  • NODE :

    节点

  • BIZPROCESS :

    业务流程

NODE
NodeIds

string

否

监控对象为节点时的节点 ID。一个规则最多监控 50 个节点，多个节点 ID 之间使用英文逗号（,）分隔。 当 RemindUnit 参数取值为 NODE（节点）时，当前参数生效。

1,2,3
BaselineIds

string

否

监控对象为基线时的基线 ID。一个规则最多监控 5 条基线，多个基线 ID 之间使用英文逗号（,）分隔。 当 RemindUnit 参数取值为 BASELINE（基线）时，当前参数生效。

1,2,3
ProjectId

integer

否

监控对象为工作空间时的工作空间 ID。一个规则只能监控一个工作空间。 当 RemindUnit 参数取值为 PROJECT（工作空间）时，当前参数生效。

1234
BizProcessIds

string

否

监控对象为业务流程时的业务流程 ID。一个规则最多监控 5 个业务流程，多个业务流程 ID 之间使用英文逗号（,）分隔。 当 RemindUnit 参数取值为 BIZPROCESS（业务流程）时，当前参数生效。

1,2,3
RemindType

string

否

触发报警规则的条件。取值如下：

  • FINISHED（完成）：表示从实例运行的起始时间点开始监控，在任务运行成功时系统发送报警。

  • UNFINISHED（未完成）：表示从实例运行的起始时间点开始监控，到指定的目标时间点任务仍未结束运行，则系统发送报警。

  • ERROR（出错）：表示从实例运行的起始时间点开始监控，当任务运行出错时，系统发送报警。

  • CYCLE_UNFINISHED（周期未完成）：表示在指定的周期内，实例仍未结束运行，则系统发送报警。通常用于监控以小时为周期单位的实例任务。

  • TIMEOUT（运行超时）：表示从实例运行的起始时间点开始监控，到指定的运行时长后，该任务仍未结束运行，则系统发送报警。通常用于监控实例任务的运行时间。

更多触发报警规则的内容，详情请参见自定义规则。

FINISHED
MaxAlertTimes

integer

否

最大报警次数。取值范围为[1,10]，默认值为 3。

3
AlertInterval

integer

否

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

1800
Detail

string

否

不同触发条件的参数配置详情，具体如下：

  • 当 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}
AlertUnit

string

否

报警的接收对象，包括 OWNER（任务责任人）和 OTHER（指定的用户）。

枚举值：

  • OTHER :

    指定的用户

  • OWNER :

    任务责任人

OWNER
AlertMethods

string

否

报警的方式，取值如下：

  • MAIL（邮件）

  • SMS（短信）

  • PHONE（电话），仅 DataWorks 专业版及以上版本支持使用电话方式接收报警。

  • DINGROBOTS（钉钉机器人），仅当配置 RobotUrls 参数后，该报警方式才会生效。

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

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

SMS,MAIL
AlertTargets

string

否

不同报警接收人的配置详情：

  • 当 AlertUnit（报警接收人）取值为 OWNER（节点任务责任人）时，当前参数配置为空。

  • 当 AlertUnit（报警接收人）取值为 OTHER（指定的用户）时，当前参数配置为指定用户的阿里云 UID。多个阿里云 UID 之间使用英文逗号（,）分隔，最多支持指定 10 个用户接收报警。

9527952795279527
UseFlag

boolean

否

是否启用报警规则，取值如下：

  • true（开启）

  • false（关闭）

true
RobotUrls

string

否

钉钉群机器人的 WebHook 地址，多个 WebHook 地址之间使用英文逗号（,）分隔。 当该参数配置为 undefined 时，系统会清空钉钉机器人的 WebHook 地址。

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

string

否

企业微信或飞书机器人的 webhook 地址，多个 webhook 地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。当该参数配置为 undefined 时，系统会清空 WebHook 地址。

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

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

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码。

200
Data

boolean

更新自定义监控规则的返回结果。

true
ErrorMessage

string

错误信息。

The specified parameters are invalid.
RequestId

string

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

0000-ABCD-EFG****
Success

boolean

调用是否成功。取值如下：

  • true（成功）

  • false（失败）

true
ErrorCode

string

错误码。

1031203110005

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area.
500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline.
500 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace.
500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
500 Forbidden.Wkbench.RemindNoPermission You are not authorized to modify the reminder.
500 Invalid.Wkbench.RemindNotExist The reminder does not exist.
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

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

变更历史

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

上一篇：DeleteRemind - 删除自定义监控报警规则下一篇：CreateRemind - 创建自定义报警规则