GetTopic - - Alibaba Cloud ドキュメントセンター

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	Yes	GetTopic	The operation that you want to perform. Set the value to GetTopic.
TopicId	Long	Yes	1234	The ID of the event. You can call the ListTopics operation to query the event ID.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code returned.
RequestId	String	0000-ABCD-EFGH-IJKLMNOPQ	The ID of the request. You can troubleshoot issues based on the ID.
ErrorMessage	String	The specified parameters are invalid.	The error message returned.
ErrorCode	String	1031203110005	The error code returned.
Success	Boolean	true	Indicates whether the request was successful.
Data	Object		The details of the event.
Owner	String	952795****	The ID of the Alibaba Cloud account used by the event owner.
TopicName	String	1234 error	The name of the event.
BaselineStatus	String	SAFE	The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.
ProjectId	Long	1234	The ID of the workspace to which the node that triggered the event belongs.
NextAlertTime	Long	1553524393000	The timestamp when the system reports the next alert.
InstanceId	Long	12345	The ID of the instance that triggered the event.
FixTime	Long	1553524393000	The timestamp when the event was processed.
BaselineInGroupId	Integer	1	The ID of the cycle of the worst baseline instance.
BaselineBuffer	Long	3600	The margin of the worst baseline instance. Unit: seconds.
TopicType	String	ERROR	The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the duration of the task is significantly longer than the average duration of the task in previous cycles. The value ERROR indicates that the task fails to run.
TopicStatus	String	FIXING	The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being processed. The value RECOVER indicates that the event is processed.
HappenTime	Long	1553524393000	The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.
DealTime	Long	1553524393000	The timestamp when the event was last processed.
DealUser	String	952795****	The ID of the Alibaba Cloud account used by the user who last processed the event.
BaselineName	String	Baseline name	The name of the baseline to which the worst baseline instance belongs.
BaselineId	Long	1234	The ID of the baseline to which the worst baseline instance belongs.
NodeName	String	Node name	The name of the node that triggered the event.
AlertTime	Long	1553524393000	The timestamp when the first alert was reported.
Buffer	Long	1200	The margin of the event. Unit: seconds.
Assigner	String	952795****	The ID of the Alibaba Cloud account used by the alert recipient.
TopicId	Long	1234	The ID of the event.
AddTime	Long	1553524393000	The timestamp when the event was found.
NodeId	Long	1234	The ID of the node that triggered the event.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetTopic
&RegionId=cn-shanghai
&TopicId=1234
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<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>1234 error</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

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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": "1234 error",
    "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 codes


HTTP status code	Error code	Error message	Description
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The error message returned because the DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.	The error message returned because the DataWorks API is unavailable in this region. Try another region.
500	Invalid.Wkbench.Parameter	The specified parameters are invalid.	The error message returned because the values of one or more parameters are invalid.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.
500	InternalError.Wkbench.ServiceError	An internal error occurred.	The error message returned because a service error has occurred.
500	Invalid.Wkbench.TopicNotExist	The topic does not exist.	The error message returned because the event does not exist.

For a list of error codes, see Service error codes.