Queries events.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| BeginTime |
string |
Yes |
The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC. |
2019-03-24T00:00:00+0800 |
| EndTime |
string |
Yes |
The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC. |
2019-03-25T23:00:00+0800 |
| TopicTypes |
string |
No |
The types of the events. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run. You can specify multiple types. Separate them with commas (,). |
ERROR,SLOW |
| TopicStatuses |
string |
No |
The status of the events. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the events are ignored. The value NEW indicates that the events are new events. The value FIXING indicates that the events are being processed. The value RECOVER indicates that the events are processed. You can specify multiple states. Separate them with commas (,). |
IGNORE,NEW,FIXING,RECOVER |
| NodeId |
integer |
No |
The ID of the node that triggers the events. You can configure either this parameter or the InstanceId parameter. |
1234 |
| InstanceId |
integer |
No |
The ID of the node instance that triggers the events. You can configure either this parameter or the NodeId parameter. |
12345 |
| Owner |
string |
No |
The ID of the Alibaba Cloud account used by the owner of the events. |
952795**** |
| PageNumber |
integer |
Yes |
The number of the page to return. Valid values: 1 to 30. Default value: 1. |
1 |
| PageSize |
integer |
Yes |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code returned. |
200 |
| RequestId |
string |
The ID of the request. You can use the ID to troubleshoot issues. |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
The error message returned. |
The specified parameters are invalid. |
| ErrorCode |
string |
The error code returned. |
1031203110005 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Data |
object |
The information about the events returned. |
|
| PageNumber |
integer |
The page number of the returned page. |
1 |
| PageSize |
integer |
The number of entries returned per page. |
10 |
| TotalCount |
integer |
The total number of the events returned. |
100 |
| Topics |
array<object> |
The events returned. |
|
|
object |
|||
| TopicName |
string |
The name of the event. |
1234 Error |
| ProjectId |
integer |
The ID of the workspace to which the node belongs. |
1234 |
| NodeOwner |
string |
The ID of the Alibaba Cloud account that is used by the node owner. |
952795**** |
| InstanceId |
integer |
The ID of the node instance that triggers the event. |
12345 |
| FixTime |
integer |
The timestamp when the event was processed. |
1553508465000 |
| TopicType |
string |
The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run. |
ERROR |
| TopicStatus |
string |
The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being processed. The value RECOVER indicates that the event is processed. |
NEW |
| HappenTime |
integer |
The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found. |
1553508465000 |
| NodeName |
string |
The name of the node. |
Node Name |
| TopicId |
integer |
The ID of the event. |
1234 |
| AddTime |
integer |
The timestamp when the event was found. |
1553524393000 |
| NodeId |
integer |
The ID of the node that triggers the event. |
1234 |
Examples
Success response
JSON format
{
"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": "1234 error",
"ProjectId": 1234,
"NodeOwner": "952795****",
"InstanceId": 12345,
"FixTime": 1553508465000,
"TopicType": "ERROR",
"TopicStatus": "NEW",
"HappenTime": 1553508465000,
"NodeName": "Node name",
"TopicId": 1234,
"AddTime": 1553524393000,
"NodeId": 1234
}
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. | No permission, please authorize |
| 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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.