Call the GetTopic operation to query the event details.

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 GetTopic

The operation that you want to perform.

RegionId String Required cn-shanghai

The unique identifier of the zone.

TopicId Long Yes 1234

The ID of the event.

Response parameters

Parameter Type Example Description
Data Struct

The details of the event.

AddTime Long 1553524393000

The time when the event was discovered.

AlertTime Long 1553524393000

The timestamp when the first alert is triggered.

Assigner String 952795****

The ID of the Alibaba Cloud UID.

BaselineBuffer Long 3600

The worst baseline instance buffer value. Unit: seconds.

BaselineId Long 1234

The ID of the worst baseline instance.

BaselineInGroupId Integer 1

The cycle number of the worst baseline instance.

BaselineName String Baseline check

The name of the worst baseline instance.

BaselineStatus String SAFE

The status of the baseline. Valid values: ERROR, SAFE, dangrouus, and OVER.

Buffer Long 1200

The buffer for the event. Unit: seconds.

DealTime Long 1553524393000

The last processing timestamp.

DealUser String 952795****

The Alibaba Cloud UID of the last handler.

FixTime Long 1553524393000

The recovery timestamp of the event.

HappenTime Long 1553524393000

The timestamp when the event occurred. There may be a time difference between the time when the event occurs and the time when the event is found.

InstanceId Long 12345

The instance ID associated with the event.

NextAlertTime Long 1553524393000

The timestamp of the next alert.

NodeId Long 1234

The ID of the node associated with the event.

NodeName String The name of the node

The name of the node associated with the event.

Owner String 952795****

The Alibaba Cloud UID of the event owner.

ProjectId Long 1234

The ID of the workspace where the node of the event-associated task is located.

TopicId Long 1234

The ID of the event.

TopicName String 1234 error

The name of the event.

TopicStatus String FIXING

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

TopicType String ERROR

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

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-EFGH-IJKLMNOPQ

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=GetTopic
&RegionId=cn-shanghai
&TopicId=1234
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <BaselineId>1234</BaselineId>
    <Buffer>1200</Buffer>
    <FixTime>1553524393000</FixTime>
    <Owner>952795****</Owner>
    <InstanceId>12345</InstanceId>
    <NodeName> node name </NodeName>
    <BaselineStatus>SAFE</BaselineStatus>
    <ProjectId>1234</ProjectId>
    <TopicStatus>FIXING</TopicStatus>
    <AddTime>1553524393000</AddTime>
    <HappenTime>1553524393000</HappenTime>
    <AlertTime>1553524393000</AlertTime>
    <BaselineInGroupId>1</BaselineInGroupId>
    <TopicName> error 1234 </TopicName>
    <TopicType>ERROR</TopicType>
    <Assigner>9527952795279528</Assigner>
    <DealUser>9527952795279528</DealUser>
    <NextAlertTime>1553524393000</NextAlertTime>
    <BaselineName> baseline name </BaselineName>
    <NodeId>1234</NodeId>
    <TopicId>1234</TopicId>
    <BaselineBuffer>3600</BaselineBuffer>
    <DealTime>1553524393000</DealTime>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid. </ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "BaselineId": 1234,
        "Buffer": 1200,
        "FixTime": 1553524393000,
        "Owner": "952795****",
        "InstanceId": 12345,
        "NodeName": "node name",
        "BaselineStatus": "SAFE",
        "ProjectId": 1234,
        "TopicStatus": "FIXING",
        "AddTime": 1553524393000,
        "HappenTime": 1553524393000,
        "AlertTime": 1553524393000,
        "BaselineInGroupId": 1,
        "TopicName": "Error 1234",
        "TopicType": "ERROR",
        "Assigner": 9527952795279528,
        "DealUser": 9527952795279528,
        "NextAlertTime": 1553524393000,
        "BaselineName": "baseline name",
        "NodeId": 1234,
        "TopicId": 1234,
        "BaselineBuffer": 3600,
        "DealTime": 1553524393000
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error code

HttpCode Error code Error message Description
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.
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 Invalid.Wkbench.Parameter The specified parameters are invalid. The parameters are invalid.
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.TopicNotExist The topic does not exist. The event does not exist.

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