Query event information by using GetTopic - DataWorks - Alibaba Cloud - DataWorks

Retrieves the details of an event.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
TopicId	integer	Yes	The ID of the event. You can call listTopics to obtain the ID. The documentation example is for format demonstration only. Valid TopicId values can be obtained from Data.Topics[].TopicId in the ListTopics response.	1234

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The unique ID of the request. You can use this ID to troubleshoot issues.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorMessage	string	The error message.	The specified parameters are invalid.
ErrorCode	string	The error code.	1031203110005
Success	boolean	Indicates whether the call was successful.	true
Data	object	The details of the event.
Owner	string	The Alibaba Cloud UID of the event owner.	952795****
TopicName	string	The name of the event.	1234 error
BaselineStatus	string	The status of the baseline. Valid values: ERROR, SAFE, DANGROUS (warning), and OVER (exceeded).	SAFE
ProjectId	integer	The ID of the workspace to which the node associated with the event belongs.	123456
NextAlertTime	integer	The timestamp of the next alert.	1553524393000
InstanceId	integer	The instance ID associated with the event.	12345
FixTime	integer	The timestamp when the event was resolved.	1553524393000
BaselineInGroupId	integer	The cycle number of the worst baseline instance.	1
BaselineBuffer	integer	The buffer of the worst baseline instance, in seconds.	3600
TopicType	string	The type of the event. Valid values: SLOW and ERROR.	ERROR
TopicStatus	string	The status of the event. Valid values: IGNORE (ignored), NEW (newly discovered), FIXING (being handled), and RECOVER (recovered).	FIXING
HappenTime	integer	The timestamp when the event occurred. There may be a time difference between when the event occurred and when it was discovered.	1553524393000
DealTime	integer	The timestamp of the last handling.	1553524393000
DealUser	string	The Alibaba Cloud UID of the last handler.	952795****
BaselineName	string	The baseline name of the worst baseline instance.	Baseline name
BaselineId	integer	The baseline ID of the worst baseline instance.	1234
NodeName	string	The name of the node associated with the event.	Node name
AlertTime	integer	The timestamp of the first alert.	1553524393000
Buffer	integer	The buffer of the event, in seconds.	1200
Assigner	string	The Alibaba Cloud UID of the assigner.	952795****
TopicId	integer	The ID of the event.	1234
AddTime	integer	The timestamp when the event was discovered.	1553524393000
NodeId	integer	The ID of the node associated with the event.	1234

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "Owner": "952795****",
    "TopicName": "1234 error",
    "BaselineStatus": "SAFE",
    "ProjectId": 123456,
    "NextAlertTime": 1553524393000,
    "InstanceId": 12345,
    "FixTime": 1553524393000,
    "BaselineInGroupId": 1,
    "BaselineBuffer": 3600,
    "TopicType": "ERROR",
    "TopicStatus": "FIXING",
    "HappenTime": 1553524393000,
    "DealTime": 1553524393000,
    "DealUser": "952795****",
    "BaselineName": "Baseline name",
    "BaselineId": 1234,
    "NodeName": "Node name",
    "AlertTime": 1553524393000,
    "Buffer": 1200,
    "Assigner": "952795****",
    "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	Invalid.Wkbench.Parameter	The specified parameters are invalid.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.Wkbench.ServiceError	An internal error occurred.	An internal error occurred.
500	Invalid.Wkbench.TopicNotExist	The topic does not exist.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.