GetTopic - 获取事件的详情

更新时间:
复制 MD 格式

调用GetTopic获取事件的详情。

接口说明


调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

TopicId

integer

事件的 ID。您可以调用 listTopics 获取。

文档示例仅用于展示格式;有效 TopicId 可通过 ListTopics 响应中的 Data.Topics[].TopicId 获取。

1234

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 返回码。

200

RequestId

string

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

0000-ABCD-EFGH-IJKLMNOPQ

ErrorMessage

string

错误信息。

The specified parameters are invalid.

ErrorCode

string

错误码。

1031203110005

Success

boolean

调用是否成功。

true

Data

object

事件的详情。

Owner

string

事件责任人的阿里云 UID。

952795****

TopicName

string

事件的名称。

1234 error

BaselineStatus

string

基线的状态,包括 ERROR(异常)、SAFE(安全)、DANGROUS(预警)和 OVER(破线)。

SAFE

ProjectId

integer

事件关联任务节点所在工作空间的 ID。

123456

NextAlertTime

integer

下次报警时间戳。

1553524393000

InstanceId

integer

事件关联的实例 ID。

12345

FixTime

integer

事件恢复时间戳。

1553524393000

BaselineInGroupId

integer

最差基线实例的周期号。

1

BaselineBuffer

integer

最差基线实例余量,单位为秒。

3600

TopicType

string

事件的类型,包括 SLOW(变慢)和 ERROR(出错)。

ERROR

TopicStatus

string

事件的状态,包括 IGNORE(已忽略)、NEW(新发现)、FIXING(处理中)和 RECOVER(已恢复)。

FIXING

HappenTime

integer

事件发生的时间戳。事件发生和被发现可能存在时间差。

1553524393000

DealTime

integer

最后处理时间戳。

1553524393000

DealUser

string

最后处理人的阿里云 UID。

952795****

BaselineName

string

最差基线实例的基线名称。

Baseline name

BaselineId

integer

最差基线实例的基线 ID。

1234

NodeName

string

事件关联的任务节点名称。

Node name

AlertTime

integer

首次报警时间戳。

1553524393000

Buffer

integer

事件的余量,单位为秒。

1200

Assigner

string

指派人的阿里云 UID。

952795****

TopicId

integer

事件的 ID。

1234

AddTime

integer

事件发现时间戳。

1553524393000

NodeId

integer

事件关联的任务节点 ID。

1234

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code

错误码

错误信息

描述

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. 服务开小差了。
500 Invalid.Wkbench.TopicNotExist The topic does not exist.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 没有权限,请授权
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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情