调用GetRemind获取自定义监控报警规则的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetRemind |
系统规定参数。取值：GetRemind。 |
| RemindId | Long | 是 | 1234 |
自定义监控规则的ID。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| HttpStatusCode | Integer | 200 |
HTTP返回码。 |
| RequestId | String | 0000-ABCD-EFGH-IJKLMNOPQ |
本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。 |
| ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
| ErrorCode | String | 1031203110005 |
错误码。 |
| Success | Boolean | true |
调用是否成功。 |
| Data | Object |
自定义监控规则的详情。 |
|
| MaxAlertTimes | Integer | 3 |
最大报警次数。 |
| RemindUnit | String | NODE |
对象的类型，包括NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和BIZPROCESS（业务流程）。 |
| AlertInterval | Integer | 1800 |
最小报警间隔，单位为秒。 |
| Useflag | Boolean | true |
自定义监控规则是否开启，包括true（开启）和false（关闭）。 |
| Founder | String | 9527951795**** |
自定义监控规则创建人的阿里云UID。 |
| RemindId | Long | 1234 |
自定义监控规则的ID。 |
| DndEnd | String | 08:00 |
免打扰截止时间，格式为hh:mm。hh的取值范围为[0,23]，mm的取值范围为[0,59]。 |
| RemindType | String | FINISHED |
触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。 |
| AlertUnit | String | OWNER |
报警接收对象的粒度，包括OWNER（任务责任人）和OTHER（指定的人）。 |
| DndStart | String | 00:00 |
免打扰起始时间，格式为hh:mm。hh的取值范围为[0,23]，mm的取值范围为[0,59]。 |
| RemindName | String | 规则名称 |
规则的名称。 |
| Detail | String | {“hour”:23,”minu”:59} |
|
| Robots | Array of Robots |
钉钉群机器人的webhook地址列表。 |
|
| WebUrl | String | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
钉钉群机器人的webhook地址。 |
| AtAll | Boolean | true |
是否@所有人，包括true（是）和false（否）。 |
| Nodes | Array of Nodes |
当RemindUnit（对象类型）为NODE（任务节点）时，该规则监控的节点列表。 |
|
| Owner | String | 9527951795**** |
节点责任人的阿里云UID。 |
| NodeName | String | 节点名称 |
节点的名称。 |
| NodeId | Long | 1234 |
节点的ID。 |
| ProjectId | Long | 1234 |
节点所在工作空间的ID。 |
| Baselines | Array of Baselines |
当RemindUnit（对象类型）为BASELINE（基线）时，该规则监控的基线列表。 |
|
| BaselineName | String | 基线名称 |
基线的名称。 |
| BaselineId | Long | 1234 |
基线的ID。 |
| Projects | Array of Projects |
当RemindUnit（对象类型）为PROJECT（工作空间）时，该规则监控的工作空间列表。 |
|
| ProjectId | Long | 1234 |
工作空间的ID。 |
| BizProcesses | Array of BizProcesses |
当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，该规则监控的业务流程列表。 |
|
| BizProcessName | String | 业务流程名称 |
业务流程名称 |
| BizId | Long | 9527 |
业务流程ID |
| AlertTargets | Array of String | 9527952795279527 |
|
| AlertMethods | Array of String | SMS,MAIL |
报警的方式，取值如下：
|
| Webhooks | Array of String | https://open.feishu.cn/open-apis/bot/v2/hook/******* |
企业微信或飞书机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。仅DataWorks企业版支持。 可用地域：华东2（上海）、西南1（成都）、华北3（张家口）、华北2（北京）、华东1（杭州）、华南1（深圳）、中国（香港）、欧洲中部 1（法兰克福）、亚太东南1（新加坡）。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetRemind
&RemindId=1234
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
0000-ABCD-EFGH-IJKLMNOPQ
The specified parameters are invalid.
1031203110005
true
3
NODE
1800
true
9527951795****
1234
08:00
FINISHED
OWNER
00:00
规则名称
{"hour":23,"minu":59}
https://oapi.dingtalk.com/robot/send?access_token=******************************
true
9527951795****
节点名称
1234
1234
基线名称
1234
1234
业务流程名称
9527
9527952795279527
SMS,MAIL
https://open.feishu.cn/open-apis/bot/v2/hook/*******
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"RequestId" : "0000-ABCD-EFGH-IJKLMNOPQ",
"ErrorMessage" : "The specified parameters are invalid.",
"ErrorCode" : 1031203110005,
"Success" : true,
"Data" : {
"MaxAlertTimes" : 3,
"RemindUnit" : "NODE",
"AlertInterval" : 1800,
"Useflag" : true,
"Founder" : "9527951795****",
"RemindId" : 1234,
"DndEnd" : "08:00",
"RemindType" : "FINISHED",
"AlertUnit" : "OWNER",
"DndStart" : "00:00",
"RemindName" : "规则名称",
"Detail" : "{\"hour\":23,\"minu\":59}",
"Robots" : {
"WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************",
"AtAll" : true
},
"Nodes" : {
"Owner" : "9527951795****",
"NodeName" : "节点名称",
"NodeId" : 1234,
"ProjectId" : 1234
},
"Baselines" : {
"BaselineName" : "基线名称",
"BaselineId" : 1234
},
"Projects" : {
"ProjectId" : 1234
},
"BizProcesses" : {
"BizProcessName" : "业务流程名称",
"BizId" : 9527
},
"AlertTargets" : "9527952795279527",
"AlertMethods" : "SMS,MAIL",
"Webhooks" : "https://open.feishu.cn/open-apis/bot/v2/hook/*******"
}
}错误码
| 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 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/171132.html