CreateRemind
创建自定义报警规则
服务地址：
华东1 金融云
输入参数
只看必填
RemindName自定义规则的名称
DndEnd免打扰截止时间
RemindUnit对象的类型
NodeIdsRemindUnit（对象类型）为NO...
BaselineIds当RemindUnit（对象类型）为B...
ProjectId当RemindUnit（对象类型）为P...
BizProcessIds当RemindUnit（对象类型）为B...
RemindType触发条件
MaxAlertTimes最大报警次数
AlertInterval最小报警间隔
Detail不同触发条件的说明如下：
AlertUnit报警接收对象的粒度
AlertMethods报警方式
AlertTargets- 当AlertUnit（报警接收人）...
RobotUrls钉钉群机器人的webhook地址
Webhooks企业微信或飞书机器人的webhook地址
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
RemindNamestring

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

示例值:test_error_remind参考取值来源:
    GetRemind
    ListReminds
DndEndstring

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

示例值:08:00
RemindUnitstring

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

示例值:NODE枚举值:NODEBASELINEPROJECTBIZPROCESS参考取值来源:
    ListReminds
    GetRemind
NodeIdsstring

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

示例值:1,2,3参考取值来源:
    ListNodes
    GetNode
    RunCycleDagNodes
BaselineIdsstring

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

示例值:1,2,3参考取值来源:
    ListBaselines
    GetBaseline
ProjectIdinteger<int64>

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

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:9527参考取值来源:
    ListProjectIds
    CreateProject
    AddProjectMemberToRole
BizProcessIdsstring

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

示例值:1,2,3
RemindTypestring

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

示例值:FINISHED枚举值:FINISHEDUNFINISHEDERRORCYCLE_UNFINISHEDTIMEOUTEXHAUSTED_ERROR参考取值来源:
    GetRemind
    ListReminds
MaxAlertTimesinteger<int32>

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

示例值:2取值 <= 10
AlertIntervalinteger<int32>

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

示例值:1800取值 >= 1200
Detailstring

不同触发条件的说明如下：展开详情

示例值:{"hour":"23","minu":"59"}参考取值来源:
    GetIDEEventDetail
AlertUnitstring

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

示例值:OWNER枚举值:OTHEROWNER
AlertMethodsstring

报警方式，取值如下：展开详情

示例值:SMS,MAIL参考取值来源:
    GetAlertMessage
    ListAlertMessages
AlertTargetsstring
  • 当 AlertUnit（报警接收人）为 OWNER（节点任务责任人）时，传空。展开详情
示例值:9527952795279527
RobotUrlsstring

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

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

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

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

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 返回码。

示例值:200
Datainteger<int64>

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

注意 请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。
示例值:1234
ErrorMessagestring

错误信息。

示例值:The specified parameters are invalid.
RequestIdstring

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

示例值:0000-ABCD-EFG****
Successboolean

调用是否成功。

示例值:true
ErrorCodestring

错误码。

示例值:1031203110005
变更历史
暂无变更历史