GetRemind - 获取自定义监控报警规则详情 - 大数据开发治理平台 DataWorks

调用GetRemind接口，获取自定义监控报警规则的详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RemindId	long	是	自定义监控规则的 ID。	1234

返回参数

名称	类型	描述	示例值
	object	返回的数据类型。
HttpStatusCode	integer	HTTP 返回码。	200
RequestId	string	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。	0000-ABCD-EFGH-IJKLMNOPQ
ErrorMessage	string	错误信息。	The specified parameters are invalid.
ErrorCode	string	错误码。	1031203110005
Success	boolean	调用是否成功。	true
Data	object	自定义监控规则的详情。
MaxAlertTimes	integer	最大报警次数。	3
RemindUnit	string	对象的类型，包括 NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和 BIZPROCESS（业务流程）。	NODE
AlertInterval	integer	最小报警间隔，单位为秒。	1800
Useflag	boolean	自定义监控规则是否开启，包括 true（开启）和 false（关闭）。	true
Founder	string	自定义监控规则创建人的阿里云 UID。	9527951795****
RemindId	long	自定义监控规则的 ID。	1234
DndEnd	string	免打扰截止时间，格式为 hh:mm。hh 的取值范围为[0,23]，mm 的取值范围为[0,59]。	08:00
RemindType	string	触发条件，包括 FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和 TIMEOUT（运行超时）。	FINISHED
AlertUnit	string	报警接收对象类型，多类型告警接收人参考出参 Receivers。 OWNER（任务责任人） OTHER（指定的人） SHIFT_SCHEDULE（值班表）	OWNER
DndStart	string	免打扰起始时间，格式为 hh:mm。hh 的取值范围为[0,23]，mm 的取值范围为[0,59]。	00:00
RemindName	string	规则的名称。	规则名称
Detail	string	当 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 分钟触发报警。	{"hour":23,"minu":59}
Robots	array<object>	钉钉群机器人的 webhook 地址列表。
Robots	object	返回的数据类型。
WebUrl	string	钉钉群机器人的 webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=******************************
AtAll	boolean	是否@所有人，包括 true（是）和 false（否）。	true
Nodes	array<object>	当 RemindUnit（对象类型）为 NODE（任务节点）时，该规则监控的节点列表。
Nodes	object	返回的数据类型。
Owner	string	节点责任人的阿里云 UID。	9527951795****
NodeName	string	节点的名称。	节点名称
NodeId	long	节点的 ID。	1234
ProjectId	long	节点所在工作空间的 ID。	1234
Baselines	array<object>	当 RemindUnit（对象类型）为 BASELINE（基线）时，该规则监控的基线列表。
Baselines	object	返回的数据类型。
BaselineName	string	基线的名称。	基线名称
BaselineId	long	基线的 ID。	1234
Projects	array<object>	当 RemindUnit（对象类型）为 PROJECT（工作空间）时，该规则监控的工作空间列表。
Projects	object	返回的数据类型。
ProjectId	long	工作空间的 ID。	1234
BizProcesses	array<object>	当 RemindUnit（对象类型）为 BIZPROCESS（业务流程）时，该规则监控的业务流程列表。
BizProcesses	object	返回的数据类型。
BizProcessName	string	业务流程名称。	业务流程名称
BizId	long	业务流程 ID。	9527
AlertTargets	array	报警接收人说明。多类型告警接收人参考出参 Receivers。
AlertTargets	string	当 AlertUnit（报警接收人）为 OWNER（节点任务责任人）时，返回空。当 AlertUnit（报警接收人）为 OTHER（指定的人）时，返回指定用户的阿里云 UID。当 AlertUnit（报警接收人）为 SHIFT_SCHEDULE（值班表）时，返回值班表 ID。	9527952795279527
AlertMethods	array	报警方式。
AlertMethods	string	报警的方式，取值如下： MAIL（邮件） SMS（短信）可使用短信告警的地域为：新加坡、马来西亚（吉隆坡）、德国（法兰克福）。	SMS,MAIL
Webhooks	array	WebHook URL
Webhooks	string	企业微信或飞书机器人的 WebHook 地址。AlertMethods 中需要包含 WebHook 告警方式。自定义 Webhook 仅 DataWorks 企业版支持。	https://open.feishu.cn/open-apis/bot/v2/hook/*******
Receivers	array<object>	告警接收人信息
Receivers	object	报警接收对象类型
AlertUnit	string	报警接收对象类型，多类型告警接收人参考出参 Receivers。 OWNER（任务责任人） OTHER（指定的人） SHIFT_SCHEDULE（值班表）	OWNER
AlertTargets	array	告警接受对象
AlertTargets	string	当 AlertUnit（报警接收人）为 OWNER（节点任务责任人）时，返回空。当 AlertUnit（报警接收人）为 OTHER（指定的人）时，返回指定用户的阿里云 UID。当 AlertUnit（报警接收人）为 SHIFT_SCHEDULE（值班表）时，返回值班表 ID。	9527952795279527
AllowNodes	array	告警白名单
allowNodes	long	白名单中的任务 ID，在监控时会被忽略。	123

示例

正常返回示例

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/*******"
    ],
    "Receivers": [
      {
        "AlertUnit": "OWNER",
        "AlertTargets": [
          "9527952795279527"
        ]
      }
    ],
    "AllowNodes": [
      123
    ]
  }
}

错误码

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	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。

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

变更历史

变更时间	变更内容概要	操作
2024-09-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情