调用UpdateRemind更新自定义监控规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateRemind |
系统规定参数。取值:UpdateRemind。 |
RemindId | Long | 是 | 1234 |
自定义规则的ID。 |
RemindName | String | 否 | update_remindname |
自定义规则的名称,不能超过128个字符。 |
DndEnd | String | 否 | 08:00 |
免打扰的截止时间,即在设置的时间之前不会发送报警。格式为hh:mm。hh的取值范围为[0,23] ,mm的取值范围为[0,59]。 |
RemindUnit | String | 否 | NODE |
监控对象的类型。取值如下:
|
NodeIds | String | 否 | 1,2,3 |
监控对象为节点时的节点ID。一个规则最多监控50个节点,多个节点ID之间使用英文逗号(,)分隔。 当RemindUnit参数取值为NODE(节点)时,当前参数生效。 |
BaselineIds | String | 否 | 1,2,3 |
监控对象为基线时的基线ID。一个规则最多监控5条基线,多个基线ID之间使用英文逗号(,)分隔。 当RemindUnit参数取值为BASELINE(基线)时,当前参数生效。 |
ProjectId | Long | 否 | 1234 |
监控对象为工作空间时的工作空间ID。一个规则只能监控一个工作空间。 当RemindUnit参数取值为PROJECT(工作空间)时,当前参数生效。 |
BizProcessIds | String | 否 | 1,2,3 |
监控对象为业务流程时的业务流程ID。一个规则最多监控5个业务流程,多个业务流程ID之间使用英文逗号(,)分隔。 当RemindUnit参数取值为BIZPROCESS(业务流程)时,当前参数生效。 |
RemindType | String | 否 | FINISHED |
触发报警规则的条件。取值如下:
更多触发报警规则的内容,详情请参见自定义规则。 |
MaxAlertTimes | Integer | 否 | 3 |
最大报警次数。取值范围为[1,10],默认值为3。 |
AlertInterval | Integer | 否 | 1800 |
报警间隔,单位为秒。最小值为1200,默认值为1800。 |
Detail | String | 否 | {"hour":23,"minu":59} |
不同触发条件的参数配置详情,具体如下:
|
AlertUnit | String | 否 | OWNER |
报警的接收对象,包括OWNER(任务责任人)和OTHER(指定的用户)。 |
AlertMethods | String | 否 | SMS,MAIL |
报警的方式,取值如下:
多个报警方式之间使用英文逗号(,)分隔。 |
AlertTargets | String | 否 | 9527952795279527 |
不同报警接收人的配置详情:
|
UseFlag | Boolean | 否 | true |
是否启用报警规则,取值如下:
|
RobotUrls | String | 否 | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
钉钉群机器人的WebHook地址,多个WebHook地址之间使用英文逗号(,)分隔。 当该参数配置为undefined时,系统会清空钉钉机器人的WebHook地址。 |
Webhooks | String | 否 | https://open.feishu.cn/open-apis/bot/v2/hook/******* |
企业微信或飞书机器人的webhook地址,多个webhook地址之间使用英文逗号(,)分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。当该参数配置为undefined时,系统会清空WebHook地址。 仅DataWorks企业版支持。 可用地域:华东2(上海)、西南1(成都)、华北3(张家口)、华北2(北京)、华东1(杭州)、华南1(深圳)、中国(香港)、欧洲中部 1(法兰克福)、亚太东南1(新加坡)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
Data | Boolean | true |
更新自定义监控规则的返回结果。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。取值如下:
|
ErrorCode | String | 1031203110005 |
错误码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateRemind
&RegionId=cn-shanghai
&RemindId=1234
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/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
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "0000-ABCD-EFG****",
"HttpStatusCode" : 200,
"Data" : true,
"ErrorCode" : 1031203110005,
"ErrorMessage" : "The specified parameters are invalid.",
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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.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.RemindNoPermission | You are not authorized to modify the reminder. | 无权限修改该自定义提醒规则。 |
500 | Invalid.Wkbench.RemindNotExist | The reminder does not exist. | 自定义提醒规则不存在。 |
访问错误中心查看更多错误码。