流控信息
授权信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
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 | |||
| 2022-11-16 |