You can call this operation to query or search for event list.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required ListTopics

The operation that you want to perform.

BeginTime String Required 2019-03-24T00:00:00+0800

The beginning of the time range to query. The time must be in UTC. The format is yyyy-MM-dd'T'HH:mm:ssZ.

EndTime String Required 2019-03-25T23:00:00+0800

The end of the time range to query. The end time must be in UTC format (yyyy-MM-dd'T'HH:mm:ssZ).

PageNumber Integer Yes 1

The number of pages that are returned. The default value is 1, the minimum value is 1, and the maximum value is 30.

PageSize Integer Yes 10

The number of returned data rows per page. The default value is 10, the minimum value is 1, and the maximum value is 100.

RegionId String Required cn-shanghai

The unique identifier of the zone.

TopicTypes String No ERROR,SLOW

The type of the event. Valid values: SLOW and ERROR. Separate multiple event types with commas (,).

TopicStatuses String No IGNORE,NEW,FIXING,RECOVER

The status of the event, including IGNORE, NEW, FIXING, and RECOVER. Separate multiple event states with commas (,).

NodeId Long No 1234

The node ID associated with the event. The IDs of InstanceId and InstanceId are mutually exclusive.

InstanceId Long No 12345

The instance ID associated with the event. The IDs of NodeId and NodeId are mutually exclusive.

Owner String No 952795****

The Alibaba Cloud UID of the event owner.

Response parameters

Parameter Type Example Description
Data Struct

The returned event list.

PageNumber Integer 1

The current page number.

PageSize Integer 10

The size of each page.

Topics Array

The events returned.

AddTime Long 1553524393000

The timestamp when the event was found.

FixTime Long 1553508465000

The timestamp when the event was resumed.

HappenTime Long 1553508465000

The time when the event is detected.

InstanceId Long 12345

The instance ID associated with the event.

NodeId Long 1234

The ID of the node associated with the event.

NodeName String The name of the node

The name of the node.

NodeOwner String 952795****

The Alibaba Cloud UID of the owner of the node.

ProjectId Long 1234

The ID of the workspace to which the task node belongs.

TopicId Long 1234

The ID of the event.

TopicName String 1234 error

The name of the event.

TopicStatus String NEW

The status of the event, including IGNORE, NEW, FIXING, and RECOVER.

TopicType String ERROR

The type of the event. Valid values: SLOW and ERROR.

TotalCount Integer 100

The total number of events.

ErrorCode String 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListTopics
&BeginTime=2019-03-24T00:00:00+0800
&EndTime=2019-03-25T23:00:00+0800
&PageNumber=1
&PageSize=10
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <Topics>
        <TopicType>ERROR</TopicType>
        <FixTime>1553508465000</FixTime>
        <NodeOwner>952795****</NodeOwner>
        <InstanceId>12345</InstanceId>
        <NodeName> node name </NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
        <TopicId>1234</TopicId>
        <TopicStatus>NEW</TopicStatus>
        <AddTime>1553524393000</AddTime>
        <HappenTime>1553508465000</HappenTime>
        <TopicName> error 1234 </TopicName>
    </Topics>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid. </ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "Topics": {
            "TopicType": "ERROR",
            "FixTime": 1553508465000,
            "NodeOwner": "952795****",
            "InstanceId": 12345,
            "NodeName": "node name",
            "NodeId": 1234,
            "ProjectId": 1234,
            "TopicId": 1234,
            "TopicStatus": "NEW",
            "AddTime": 1553524393000,
            "HappenTime": 1553508465000,
            "TopicName": "Error 1234"
        },
        "PageSize": 10,
        "PageNumber": 1
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. DataWorks API service is not available in this region. Please try another region.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The service was open.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The parameters are invalid.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The number of resources has reached the upper limit. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.

For a list of error codes, visit the API Error Center.