使用ListReminds擷取或搜尋自訂監控規則列表-巨量資料開發治理平台 DataWorks-阿里雲

擷取或搜尋自訂監控規則列表。

調試

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

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	是	分頁的頁數。預設值為 1，最小值為 1，最大值為 30。	1
PageSize	integer	是	每頁顯示的條數，預設為 10 條，最大 100 條。	10
Founder	string	否	建立人的阿里雲 UID。	9527952795****
NodeId	integer	否	規則的對象，任務節點 ID。您可以根據任務節點 ID 搜尋覆蓋該任務節點的自訂監控規則。	1234
RemindTypes	string	否	觸發條件，包括 FINISHED（完成）、UNFINISHED（未完成）、ERROR（出錯）、CYCLE_UNFINISHED（周期未完成）和 TIMEOUT（運行逾時）。多個觸發條件之間使用英文逗號（,）分隔。	FINISHED,ERROR
AlertTarget	string	否	警示接收人的阿里雲 UID。	9527952795****
SearchText	string	否	搜尋規則名稱。	模糊搜尋規則名稱

返回參數

名稱	類型	描述	樣本值
	object
HttpStatusCode	integer	HTTP 返回碼。	200
RequestId	string	本次調用的唯一 ID。出現錯誤後，您可以根據該 ID 排查問題。	0000-ABCD-EFG****
ErrorMessage	string	錯誤資訊。	The specified parameters are invalid.
ErrorCode	string	錯誤碼。	1031203110005
Success	boolean	調用是否成功。	true
Data	object	返回的自訂監控規則列表。
PageNumber	integer	當前的頁數。	1
PageSize	integer	每頁的大小。	10
TotalCount	integer	自訂監控規則的總數。	100
Reminds	array<object>	自訂監控規則列表。
	object	自訂監控規則列表。
Founder	string	規則建立人的阿里雲 UID。	952795****
RemindId	integer	自訂監控規則的 ID。	1234
AlertUnit	string	警示接收對象的粒度，包括 OWNER（任務責任人）和 OTHER（指定的人）。	OWNER
RemindType	string	觸發條件，包括 FINISHED（完成）、UNFINISHED（未完成）、ERROR（出錯）、CYCLE_UNFINISHED（周期未完成）和 TIMEOUT（運行逾時）。	FINISHED
DndEnd	string	免打擾截止時間，格式為 hh:mm。hh 的取值範圍為[0,23]，mm 的取值範圍為[0,59]。	08:00
DndStart	string	免打擾起始時間，格式為 hh:mm。hh 的取值範圍為[0,23]，mm 的取值範圍為[0,59]。	00:00
RemindUnit	string	對象的類型，包括 NODE（任務節點）、BASELINE（基準）、PROJECT（工作空間）和 BIZPROCESS（商務程序）。	NODE
Useflag	boolean	規則是否開啟，包括 true（開啟）和 false（關閉）。	true
RemindName	string	自訂監控規則的名稱。	規則名稱
AlertTargets	array	警示接收人的阿里雲 UID 清單。
	string	警示接收人的阿里雲 UID 清單。	952795****
NodeIds	array	當 RemindUnit（物件類型）為 NODE（任務節點）時，監控的節點 ID 列表。
	integer	當 RemindUnit（物件類型）為 NODE（任務節點）時，監控的節點 ID 列表。	1234
BizProcessIds	array	當 RemindUnit（物件類型）為 BIZPROCESS（商務程序）時，監控的基準 ID 列表。
	integer	當 RemindUnit（物件類型）為 BIZPROCESS（商務程序）時，監控的基準 ID 列表。	9527
ProjectIds	array	當 RemindUnit（物件類型）為 PROJECT（工作空間）時，監控的節點 ID 列表。
	integer	當 RemindUnit（物件類型）為 PROJECT（工作空間）時，監控的節點 ID 列表。	1234
BaselineIds	array	當 RemindUnit（物件類型）為 BASELINE（基準）時，監控的基準 ID 列表。
	integer	當 RemindUnit（物件類型）為 BASELINE（基準）時，監控的基準 ID 列表。	9527
AlertMethods	array	警示的方式，包括 MAIL（郵件）、SMS（簡訊）和 PHONE（電話，僅 DataWorks 專業版及以上版本支援）。
	string	警示的方式，包括 MAIL（郵件）、SMS（簡訊）和 PHONE（電話，僅 DataWorks 專業版及以上版本支援）。	SMS

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Reminds": [
      {
        "Founder": "952795****",
        "RemindId": 1234,
        "AlertUnit": "OWNER",
        "RemindType": "FINISHED",
        "DndEnd": "08:00",
        "DndStart": "00:00",
        "RemindUnit": "NODE",
        "Useflag": true,
        "RemindName": "規則名稱",
        "AlertTargets": [
          "952795****"
        ],
        "NodeIds": [
          1234
        ],
        "BizProcessIds": [
          9527
        ],
        "ProjectIds": [
          1234
        ],
        "BaselineIds": [
          9527
        ],
        "AlertMethods": [
          "SMS"
        ]
      }
    ]
  }
}

錯誤碼

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.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

變更歷史

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