GetTopic-DataWorks(DataWorks)-阿里云帮助中心

Queries the details of a specified 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 event ID. You can call the ListTopics operation to query the ID.	1234

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	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 request was successful.	true
Data	object	The details of the event.
Owner	string	The ID of the Alibaba Cloud account 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, and OVER. ERROR indicates that no nodes are associated with the baseline, or all associated nodes are suspended. SAFE indicates that nodes finish running before the alert duration begins. DANGROUS indicates that nodes are still running after the alert duration ends but the committed completion time has not arrived. OVER indicates that nodes are still running after the committed completion time.	SAFE
ProjectId	integer	The ID of the workspace to which the node that triggered the event belongs.	123456
NextAlertTime	integer	The timestamp of the next scheduled alert.	1553524393000
InstanceId	integer	The ID of the instance that triggered the event.	12345
FixTime	integer	The timestamp when the event was processed.	1553524393000
BaselineInGroupId	integer	The ID of the cycle of the worst baseline instance.	1
BaselineBuffer	integer	The margin of the worst baseline instance. Unit: seconds.	3600
TopicType	string	The type of the event. Valid values: SLOW and ERROR. SLOW indicates that the task duration is significantly longer than the average duration in previous cycles. ERROR indicates that the task failed to run.	ERROR
TopicStatus	string	The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER.	FIXING
HappenTime	integer	The timestamp when the event occurred. A time difference may exist between event occurrence and event detection.	1553524393000
DealTime	integer	The timestamp when the event was last processed.	1553524393000
DealUser	string	The ID of the Alibaba Cloud account of the user who last processed the event.	952795****
BaselineName	string	The name of the baseline to which the worst baseline instance belongs.	Baseline name
BaselineId	integer	The ID of the baseline to which the worst baseline instance belongs.	1234
NodeName	string	The name of the node that triggered the event.	Node name
AlertTime	integer	The timestamp when the first alert was reported.	1553524393000
Buffer	integer	The margin of the event. Unit: seconds.	1200
Assigner	string	The ID of the Alibaba Cloud account of the alert recipient.	952795****
TopicId	integer	The event ID.	1234
AddTime	integer	The timestamp when the event was found.	1553524393000
NodeId	integer	The ID of the node that triggered 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.