流控信息
授权信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
RemindNamestring | 自定义规则的名称，不能超过 128 个字符。 示例值:test_error_remind |
DndEndstring | 免打扰截止时间，格式为 hh:mm。hh 的取值范围为[0,23]，mm 的取值范围为[0,59]。 示例值:08:00 |
RemindUnitstring | 对象的类型，包括 NODE（任务节点）、BASELINE（基线） 、PROJECT（工作空间）和 BIZPROCESS（业务流程）。 示例值:NODE枚举值:NODEBASELINEPROJECTBIZPROCESS |
NodeIdsstring | RemindUnit（对象类型）为 NODE（任务节点）时，监控的任务节点 ID。多个 ID 之间使用英文逗号（,）分隔，一个规则最多监控 50 个节点。 示例值:1,2,3 |
BaselineIdsstring | 当 RemindUnit（对象类型）为 BASELINE（基线）时，监控的基线 ID。多个 ID 之间使用英文逗号（,）分隔，一个规则最多监控 5 条基线。 示例值:1,2,3 |
ProjectIdinteger<int64> | 当 RemindUnit（对象类型）为 PROJECT（工作空间）时，监控的工作空间 ID。一个规则只能监控一个工作空间。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:9527 |
BizProcessIdsstring | 当 RemindUnit（对象类型）为 BIZPROCESS（业务流程）时，监控的业务流程 ID。多个业务流程 ID 之间使用英文逗号（,）分隔，一个规则最多监控 5 个业务流程。 示例值:1,2,3 |
RemindTypestring | 触发条件，包括 FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、 CYCLE_UNFINISHED（周期未完成）和 TIMEOUT（运行超时）。 示例值:FINISHED枚举值:FINISHEDUNFINISHEDERRORCYCLE_UNFINISHEDTIMEOUTEXHAUSTED_ERROR |
MaxAlertTimesinteger<int32> | 最大报警次数。最小值为 1，最大值为 10，默认值为 3。 示例值:2取值 <= 10 |
AlertIntervalinteger<int32> | 最小报警间隔，单位为秒。最小值为 1200，默认值为 1800。 示例值:1800取值 >= 1200 |
Detailstring | 不同触发条件的说明如下：展开详情 示例值:{"hour":"23","minu":"59"} |
AlertUnitstring | 报警接收对象的粒度，包括 OWNER（任务责任人）和 OTHER（指定的人）。 示例值:OWNER枚举值:OTHEROWNER |
AlertMethodsstring | 报警方式，取值如下：展开详情 示例值:SMS,MAIL |
AlertTargetsstring |
示例值: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 |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2022-11-16 |