调用CreateRemind创建自定义报警规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateRemind |
要执行的操作。 |
AlertUnit | String | 是 | OWNER |
报警接收对象的粒度,包括OWNER(任务责任人)和OTHER(指定的人)。 |
RegionId | String | 是 | cn-shanghai |
可用区的唯一标识。 |
RemindName | String | 是 | test_error_remind |
自定义规则的名称,不能超过128个字符。 |
RemindType | String | 是 | FINISHED |
触发条件,包括FINISHED(完成)、UNFINISHED(未完成)、ERROR(出错)、 CYCLE_UNFINISHED(周期未完成)和TIMEOUT(运行超时)。 |
RemindUnit | String | 是 | NODE |
对象的类型,包括NODE(任务节点)、BASELINE(基线) 、PROJECT(工作空间)和BIZPROCESS(业务流程)。 |
DndEnd | String | 否 | 08:00 |
免打扰截止时间,格式为hh:mm。hh的取值范围为[0,23],mm的取值范围为[0,59]。 |
NodeIds | String | 否 | 1,2,3 |
RemindUnit(对象类型)为NODE(任务节点)时,监控的任务节点ID。多个ID之间使用英文逗号(,)分隔,一个规则最多监控50个节点。 |
BaselineIds | String | 否 | 1,2,3 |
当RemindUnit(对象类型)为BASELINE(基线)时,监控的基线ID。多个ID之间使用英文逗号(,)分隔,一个规则最多监控5条基线。 |
ProjectId | Long | 否 | 9527 |
当RemindUnit(对象类型)为PROJECT(工作空间)时,监控的工作空间ID。一个规则只能监控一个工作空间。 |
BizProcessIds | String | 否 | 1,2,3 |
当RemindUnit(对象类型)为BIZPROCESS(业务流程)时,监控的业务流程ID。多个业务流程ID之间使用英文逗号(,)分隔,一个规则最多监控5个业务流程。 |
MaxAlertTimes | Integer | 否 | 2 |
最大报警次数。最小值为1,最大值为10,默认值为3。 |
AlertInterval | Integer | 否 | 1800 |
最小报警间隔,单位为秒。最小值为1200,默认值为1800。 |
Detail | String | 否 | {"hour":23,"minu":59} |
不同触发条件的说明如下:
|
AlertMethods | String | 否 | SMS,MAIL |
报警的方式,包括MAIL(邮件),SMS(短信)和PHONE(电话,仅DataWorks专业版及以上版本支持)。多个报警方式之间使用英文逗号(,)分隔。 |
AlertTargets | String | 否 | 9527952795279527 |
|
RobotUrls | String | 否 | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
钉钉群机器人的webhook地址,多个webhook地址之间使用英文逗号(,)分隔。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Long | 1234 |
创建自定义监控规则成功后,返回的自定义规则ID。 |
ErrorCode | String | 1031203110005 |
错误码。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateRemind
&AlertUnit=OWNER
&RegionId=cn-shanghai
&RemindName=test_error_remind
&RemindType=FINISHED
&RemindUnit=NODE
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>9527</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>
JSON
格式
{
"RequestId": "0000-ABCD-EFG****",
"HttpStatusCode": 200,
"Data": 9527,
"ErrorCode": 1031203110005,
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | InternalError.Wkbench.ServiceError | An internal error occurred. | 服务开小差了。 |
500 | Invalid.Wkbench.Parameter | The specified parameters are invalid. | 参数错误。 |
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.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. | 自定义提醒规则创建超限。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。