UpdateRemind
更新自定义监控规则
服务地址:
华东1 金融云
输入参数
只看必填
RemindId自定义规则的ID
RemindName自定义规则的名称
DndEnd免打扰的截止时间
RemindUnit监控对象的类型
NodeIds监控对象为节点时的节点ID
BaselineIds监控对象为基线时的基线ID
ProjectId监控对象为工作空间时的工作空间ID
BizProcessIds监控对象为业务流程时的业务流程ID
RemindType触发报警规则的条件
MaxAlertTimes最大报警次数
AlertInterval报警间隔
Detail不同触发条件的参数配置详情
AlertUnit报警的接收对象
AlertMethods报警的方式
AlertTargets不同报警接收人的配置详情:
UseFlag是否启用报警规则
请选择布尔值
RobotUrls钉钉群机器人的WebHook地址
Webhooks企业微信或飞书机器人的webhook地址
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
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
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
RemindIdinteger<int64>

自定义规则的 ID。

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

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

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

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

示例值:08:00
RemindUnitstring

监控对象的类型。取值如下:展开详情

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

监控对象为节点时的节点 ID。一个规则最多监控 50 个节点,多个节点 ID 之间使用英文逗号(,)分隔。展开详情

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

监控对象为基线时的基线 ID。一个规则最多监控 5 条基线,多个基线 ID 之间使用英文逗号(,)分隔。展开详情

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

监控对象为工作空间时的工作空间 ID。一个规则只能监控一个工作空间。展开详情

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

监控对象为业务流程时的业务流程 ID。一个规则最多监控 5 个业务流程,多个业务流程 ID 之间使用英文逗号(,)分隔。展开详情

示例值:1,2,3
RemindTypestring

触发报警规则的条件。取值如下:展开详情

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

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

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

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

示例值:1800取值 <= 1800
Detailstring

不同触发条件的参数配置详情,具体如下:展开详情

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

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

示例值:OWNER枚举值:OTHEROWNER
AlertMethodsstring

报警的方式,取值如下:展开详情

示例值:SMS,MAIL参考取值来源:
    GetAlertMessage
    ListAlertMessages
AlertTargetsstring

不同报警接收人的配置详情:展开详情

示例值:9527952795279527
UseFlagboolean

是否启用报警规则,取值如下:展开详情

示例值:true
RobotUrlsstring

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

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

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

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

返回参数

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

HTTP 状态码。

示例值:200
Databoolean

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

示例值:true
ErrorMessagestring

错误信息。

示例值:The specified parameters are invalid.
RequestIdstring

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

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

调用是否成功。取值如下:展开详情

示例值:true
ErrorCodestring

错误码。

示例值:1031203110005
变更历史
变更时间变更内容概要操作
2023-10-20
变更请求参数RemindType
2022-11-16
新增请求参数Webhooks