调用CreateRemind创建自定义报警规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RemindName | string | 是 | 自定义规则的名称,不能超过 128 个字符。 | test_error_remind |
DndEnd | string | 否 | 免打扰截止时间,格式为 hh:mm。hh 的取值范围为[0,23],mm 的取值范围为[0,59]。 | 08:00 |
RemindUnit | string | 是 | 对象的类型,包括 NODE(任务节点)、BASELINE(基线) 、PROJECT(工作空间)和 BIZPROCESS(业务流程)。 | NODE |
NodeIds | string | 否 | RemindUnit(对象类型)为 NODE(任务节点)时,监控的任务节点 ID。多个 ID 之间使用英文逗号(,)分隔,一个规则最多监控 50 个节点。 | 1,2,3 |
BaselineIds | string | 否 | 当 RemindUnit(对象类型)为 BASELINE(基线)时,监控的基线 ID。多个 ID 之间使用英文逗号(,)分隔,一个规则最多监控 5 条基线。 | 1,2,3 |
ProjectId | long | 否 | 当 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 | 否 | 不同触发条件的说明如下:
| {"hour":"23","minu":"59"} |
AlertUnit | string | 是 | 报警接收对象的粒度,包括 OWNER(任务责任人)和 OTHER(指定的人)。 | OWNER |
AlertMethods | string | 是 | 报警方式,取值如下:
多个报警方式之间使用英文逗号(,)分隔。 | SMS,MAIL |
AlertTargets | string | 否 |
| 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/******* |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"Data": 1234,
"ErrorMessage": "The specified parameters are invalid.",
"RequestId": "0000-ABCD-EFG****",
"Success": true,
"ErrorCode": "1031203110005"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | 该地域还未开放DataWorks的API服务,请尝试其它地域。 |
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. | 自定义提醒规则创建超限。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|