調用GetRemind介面擷取自訂監控警示規則詳情-巨量資料開發治理平台 DataWorks-阿里雲

調用GetRemind介面，擷取自訂監控警示規則的詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RemindId	integer	是	自訂監控規則的 ID。	1234

返回參數

名稱	類型	描述	樣本值
	object	返回的資料類型。
HttpStatusCode	integer	HTTP 返回碼。	200
RequestId	string	本次調用的唯一 ID。出現錯誤後，您可以根據該 ID 排查問題。	0000-ABCD-EFGH-IJK****
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	integer	自訂監控規則的 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	規則的名稱。	Rule name
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>	DingTalk群機器人的 webhook 地址清單。
	object	返回的資料類型。
WebUrl	string	DingTalk群機器人的 webhook 地址。	https://oapi.dingtalk.com/robot/send?access_token=******************************
AtAll	boolean	是否@所有人，包括 true（是）和 false（否）。	true
Nodes	array<object>	當 RemindUnit（物件類型）為 NODE（任務節點）時，該規則監控的節點列表。
	object	返回的資料類型。
Owner	string	節點責任人的阿里雲 UID。	9527951795****
NodeName	string	節點的名稱。	Node name
NodeId	integer	節點的 ID。	1234
ProjectId	integer	節點所在工作空間的 ID。	1234
Baselines	array<object>	當 RemindUnit（物件類型）為 BASELINE（基準）時，該規則監控的基準列表。
	object	返回的資料類型。
BaselineName	string	基準的名稱。	Baseline name
BaselineId	integer	基準的 ID。	1234
Projects	array<object>	當 RemindUnit（物件類型）為 PROJECT（工作空間）時，該規則監控的工作空間列表。
	object	返回的資料類型。
ProjectId	integer	工作空間的 ID。	1234
BizProcesses	array<object>	當 RemindUnit（物件類型）為 BIZPROCESS（商務程序）時，該規則監控的商務程序列表。
	object	返回的資料類型。
BizProcessName	string	商務程序名稱。	Business process name
BizId	integer	商務程序 ID。	9527
AlertTargets	array	警示接收人說明。多類型警示接收人蔘考出參 Receivers。
	string	當 AlertUnit（警示接收人）為 OWNER（節點任務責任人）時，返回空。當 AlertUnit（警示接收人）為 OTHER（指定的人）時，返回指定使用者的阿里雲 UID。當 AlertUnit（警示接收人）為 SHIFT_SCHEDULE（值班表）時，傳回值班表 ID。	9527952795279527
AlertMethods	array	警示方式。
	string	警示的方式，取值如下： MAIL（郵件） SMS（簡訊）可使用簡訊警示的地區為：新加坡、馬來西亞（吉隆坡）、德國（法蘭克福）。	SMS,MAIL
Webhooks	array	WebHook URL
	string	企業微信或飛書機器人的 WebHook 地址。AlertMethods 中需要包含 WebHook 警示方式。自訂 Webhook 僅 DataWorks 企業版支援。	https://open.feishu.cn/open-apis/bot/v2/hook/*******
Receivers	array<object>	警示接收人資訊。
	object	警示接收物件類型。
AlertUnit	string	警示接收物件類型，多類型警示接收人蔘考出參 Receivers。 OWNER（任務責任人） OTHER（指定的人） SHIFT_SCHEDULE（值班表）	OWNER
AlertTargets	array	警示接受對象。
	string	當 AlertUnit（警示接收人）為 OWNER（節點任務責任人）時，返回空。當 AlertUnit（警示接收人）為 OTHER（指定的人）時，返回指定使用者的阿里雲 UID。當 AlertUnit（警示接收人）為 SHIFT_SCHEDULE（值班表）時，傳回值班表 ID。	9527952795279527
AllowNodes	array	警示白名單。
	integer	白名單中的任務 ID，在監控時會被忽略。	123

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFGH-IJK****",
  "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": "Rule name",
    "Detail": "{\"hour\":23,\"minu\":59}",
    "Robots": [
      {
        "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************",
        "AtAll": true
      }
    ],
    "Nodes": [
      {
        "Owner": "9527951795****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Baselines": [
      {
        "BaselineName": "Baseline name",
        "BaselineId": 1234
      }
    ],
    "Projects": [
      {
        "ProjectId": 1234
      }
    ],
    "BizProcesses": [
      {
        "BizProcessName": "Business process name",
        "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	錯誤碼	錯誤資訊	描述
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.
429	Throttling.User	Your request is too frequent. Try again later.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。