呼叫 ListTopics 取得或搜尋事件清單。
介面說明
前置條件：呼叫本介面前，請先開通 DataWorks 企業版或旗艦版；未開通時服務會返回 403 Forbidden.Access。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| BeginTime |
string |
是 |
起始發現時間，需要使用 UTC 格式（yyyy-MM-dd'T'HH:mm:ssZ）。 |
2019-03-24T00:00:00+0800 |
| EndTime |
string |
是 |
截止發現時間，需要使用 UTC 格式（yyyy-MM-dd'T'HH:mm:ssZ）。 |
2019-03-25T23:00:00+0800 |
| TopicTypes |
string |
否 |
事件的類型，包括 SLOW（變慢）和 ERROR（出錯）。多個事件類型之間使用英文逗號（,）分隔。 |
ERROR,SLOW |
| TopicStatuses |
string |
否 |
事件的狀態，包括 IGNORE（已忽略）、NEW（新發現）、FIXING（處理中）和 RECOVER（已恢復）。多個事件狀態之間使用英文逗號（,）分隔。 |
IGNORE,NEW,FIXING,RECOVER |
| NodeId |
integer |
否 |
事件關聯的工作節點 ID，與參數 InstanceId 互斥。 |
1234 |
| InstanceId |
integer |
否 |
事件關聯的執行個體 ID，與參數 NodeId 互斥。 |
12345 |
| Owner |
string |
否 |
事件負責人的阿里雲 UID。 |
952795**** |
| PageNumber |
integer |
是 |
分頁的頁數。預設值為 1，最小值為 1，最大值為 30。 |
1 |
| PageSize |
integer |
是 |
每頁顯示的筆數，預設為 10 筆，最大 100 筆。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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 |
| Topics |
array<object> |
事件清單。 |
|
|
object |
|||
| TopicName |
string |
事件的名稱。 |
Error 1234 |
| ProjectId |
integer |
任務節點所在工作空間的 ID。 |
1234 |
| NodeOwner |
string |
任務節點責任人的阿里雲 UID |
952795**** |
| InstanceId |
integer |
事件關聯的執行個體 ID。 |
12345 |
| FixTime |
integer |
事件恢複的時間戳記。 |
1553508465000 |
| TopicType |
string |
事件的類型，包括 SLOW（變慢）和 ERROR（出錯）。 |
ERROR |
| TopicStatus |
string |
事件的狀態，包括 IGNORE（已忽略）、NEW（新發現）、FIXING（處理中）和 RECOVER（已恢複）。 |
NEW |
| HappenTime |
integer |
事件發生的時間戳記，事件發生和被發現存在一定的時間差。 |
1553508465000 |
| NodeName |
string |
任務節點的名稱。 |
Node name |
| TopicId |
integer |
事件的 ID。 |
1234 |
| AddTime |
integer |
事件發現的時間戳記。 |
1553524393000 |
| NodeId |
integer |
事件關聯的任務節點 ID。 |
1234 |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The specified parameters are invalid.",
"ErrorCode": "1031203110005",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Topics": [
{
"TopicName": "Error 1234",
"ProjectId": 1234,
"NodeOwner": "952795****",
"InstanceId": 12345,
"FixTime": 1553508465000,
"TopicType": "ERROR",
"TopicStatus": "NEW",
"HappenTime": 1553508465000,
"NodeName": "Node name",
"TopicId": 1234,
"AddTime": 1553524393000,
"NodeId": 1234
}
]
}
}錯誤碼
|
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。