ListTopics

Queries or searches for a list of events.

Operation description

Before you begin: Activate DataWorks Enterprise Edition or Ultimate Edition before calling this operation. If the edition is not activated, the service returns 403 Forbidden.Access.

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
BeginTime	string	Yes	The start time for discovery. Specify the time in UTC format (yyyy-MM-dd'T'HH:mm:ssZ).	2019-03-24T00:00:00+0800
EndTime	string	Yes	The end time for discovery. Specify the time in UTC format (yyyy-MM-dd'T'HH:mm:ssZ).	2019-03-25T23:00:00+0800
TopicTypes	string	No	The type of the event. Valid values: SLOW (slow) and ERROR (error). Separate multiple event types with commas (,).	ERROR,SLOW
TopicStatuses	string	No	The status of the event. Valid values: IGNORE (ignored), NEW (newly discovered), FIXING (being processed), and RECOVER (recovered). Separate multiple event statuses with commas (,).	IGNORE,NEW,FIXING,RECOVER
NodeId	integer	No	The ID of the node associated with the event. This parameter is mutually exclusive with InstanceId.	1234
InstanceId	integer	No	The instance ID associated with the event. This parameter is mutually exclusive with NodeId.	12345
Owner	string	No	The Alibaba Cloud UID of the event owner.	952795****
PageNumber	integer	Yes	The page number. Default value: 1. Minimum value: 1. Maximum value: 30.	1
PageSize	integer	Yes	The number of entries per page. Default value: 10. Maximum value: 100.	10

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-EFG****
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 returned event list.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of events.	100
Topics	array<object>	The list of events.
	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 Alibaba Cloud UID of the node owner.	952795****
InstanceId	integer	The instance ID associated with the event.	12345
FixTime	integer	The timestamp when the event was recovered.	1553508465000
TopicType	string	The type of the event. Valid values: SLOW (slow) and ERROR (error).	ERROR
TopicStatus	string	The status of the event. Valid values: IGNORE (ignored), NEW (newly discovered), FIXING (being processed), and RECOVER (recovered).	NEW
HappenTime	integer	The timestamp when the event occurred. There is a time difference between when the event occurs and when it is discovered.	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 discovered.	1553524393000
NodeId	integer	The ID of the node associated with 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.