UpdateRemind - DataWorks

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	UpdateRemind	要执行的操作。
AlertInterval	Integer	是	1800	最小报警间隔，单位为秒。最小值为1200，默认值为1800。
RegionId	String	是	cn-shanghai	可用区的唯一标识。
RemindId	Long	是	1234	自定义监控规则ID。
RemindName	String	否	update_remindname	自定义规则的名称，不能超过128个字符。
DndEnd	String	否	08:00	免打扰截止时间，格式为hh:mm。hh的取值范围为[0,23] ，mm的取值范围为[0,59]。
RemindUnit	String	否	NODE	对象的类型，包括NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和BIZPROCESS（业务流程）。
NodeIds	String	否	1,2,3	当RemindUnit（对象类型）为NODE（任务节点）时，监控的任务节点ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控50个节点。
BaselineIds	String	否	1,2,3	当RemindUnit（对象类型）为BASELINE（基线）时，监控的基线ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控5条基线。
ProjectId	Long	否	1234	当RemindUnit（对象类型）为PROJECT（工作空间）时，监控的工作空间ID。一个规则只能监控一个工作空间。
BizProcessIds	String	否	1,2,3	当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，监控的业务流程ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控5个业务流程。
RemindType	String	否	FINISHED	触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、 CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。
MaxAlertTimes	Integer	否	3	最大报警次数。最小值为1，最大值为10，默认值为3。
Detail	String	否	{"hour":23,"minu":59}	不同触发条件的说明如下：当RemindType（触发条件）为FINISHED（完成）时，传空。当RemindType（触发条件）为UNFINISHED（未完成）时，传参格式为{"hour":23,"minu":59}。hour的取值范围为[0,47]，minu的取值范围为[0,59]。当RemindType（触发条件）为ERROR（出错）时，传空。当RemindType（触发条件）为CYCLE_UNFINISHED（周期未完成）时，传参格式为{"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}。JSON字符串key为周期号，取值范围为[1,288]。value为该周期对应的未完成时间，格式为hh:mm。hh的取值范围为[0,47]，mm的取值范围为[0,59]。当RemindType（触发条件）为TIMEOUT（运行超时）时，传参格式为1800，单位为秒。即从开始运行起，运行超过30分钟触发报警。
AlertUnit	String	否	OWNER	报警接收对象的粒度，包括OWNER（任务责任人）和OTHER（指定的人）。
AlertMethods	String	否	SMS,MAIL	报警的方式，包括MAIL（邮件）、SMS（短信）和 PHONE（电话，仅DataWorks专业版及以上版本支持）。多个报警方式之间使用英文逗号（,）分隔。
AlertTargets	String	否	9527952795279527	当AlertUnit（报警接收人）为OWNER（节点任务责任人）时，传空。当AlertUnit报警接收人）为OTHER（指定的人）时，传入指定用户的阿里云UID。多个阿里云UID之间使用英文逗号（,）分隔，最多支持10个。
UseFlag	Boolean	否	true	开启和关闭规则，包括true（开启）和false（关闭）。
RobotUrls	String	否	https://oapi.dingtalk.com/robot/send?access_token=******************************	钉钉群机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。

返回数据


名称	类型	示例值	描述
Data	Boolean	true	更新自定义监控规则是否成功，包括true（成功）和false（失败）。
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=UpdateRemind
&AlertInterval=1800
&RegionId=cn-shanghai
&RemindId=1234
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>true</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": true,
    "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	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.RemindNoPermission	You are not authorized to modify the reminder.	无权限修改该自定义提醒规则。
500	Invalid.Wkbench.RemindNotExist	The reminder does not exist.	自定义提醒规则不存在。

访问错误中心查看更多错误码。