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

CreateRemind - 创建自定义报警规则

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

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
RemindName

string

是

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

test_error_remind
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

否

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

1,2,3
BaselineIds

string

否

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

1,2,3
ProjectId

integer

否

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

9527
BizProcessIds

string

否

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

1,2,3
RemindType

string

是

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

FINISHED
MaxAlertTimes

integer

否

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

2
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 专业版及以上版本支持。

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

  • DINGROBOTS：钉钉群机器人。

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

SMS,MAIL
AlertTargets

string

否

  • 当 AlertUnit（报警接收人）为 OWNER（节点任务责任人）时，传空。

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

9527952795279527
RobotUrls

string

否

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

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

string

否

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

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

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

返回参数

名称

类型

描述

示例值

object

请求返回结果

HttpStatusCode

integer

HTTP 返回码。

200
Data

integer

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

1234
ErrorMessage

string

错误信息。

The specified parameters are invalid.
RequestId

string

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

0000-ABCD-EFG****
Success

boolean

调用是否成功。

true
ErrorCode

string

错误码。

1031203110005

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 1234,
  "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.NoProject You have not joined any project.
500 Invalid.Wkbench.NodeNotExist The node does not exist.
500 Invalid.Wkbench.BaselineNotExist The baseline does not exist.
500 Forbidden.Wkbench.RemindOverlimit The maximum number of reminders is exceeded.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 没有权限，请授权
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.

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

变更历史

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

上一篇：UpdateRemind - 更新自定义报警规则下一篇：GetRemind - 获取自定义监控报警规则详情