文档

GetTopic - 获取事件的详情

更新时间:

调用GetTopic获取事件的详情。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
TopicIdlong

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

1234

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 返回码。

200
RequestIdstring

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

0000-ABCD-EFGH-IJKLMNOPQ
ErrorMessagestring

错误信息。

The specified parameters are invalid.
ErrorCodestring

错误码。

1031203110005
Successboolean

调用是否成功。

true
Dataobject

事件的详情。

Ownerstring

事件责任人的阿里云 UID。

952795****
TopicNamestring

事件的名称。

1234出错
BaselineStatusstring

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

SAFE
ProjectIdlong

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

1234
NextAlertTimelong

下次报警时间戳。

1553524393000
InstanceIdlong

事件关联的实例 ID。

12345
FixTimelong

事件恢复时间戳。

1553524393000
BaselineInGroupIdinteger

最差基线实例的周期号。

1
BaselineBufferlong

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

3600
TopicTypestring

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

ERROR
TopicStatusstring

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

FIXING
HappenTimelong

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

1553524393000
DealTimelong

最后处理时间戳。

1553524393000
DealUserstring

最后处理人的阿里云 UID。

952795****
BaselineNamestring

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

基线名称
BaselineIdlong

最差基线实例的基线 ID。

1234
NodeNamestring

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

节点名称
AlertTimelong

首次报警时间戳。

1553524393000
Bufferlong

事件的余量,单位为秒。

1200
Assignerstring

指派人的阿里云 UID。

952795****
TopicIdlong

事件的 ID。

1234
AddTimelong

事件发现时间戳。

1553524393000
NodeIdlong

事件关联的任务节点 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出错",
    "BaselineStatus": "SAFE",
    "ProjectId": 1234,
    "NextAlertTime": 1553524393000,
    "InstanceId": 12345,
    "FixTime": 1553524393000,
    "BaselineInGroupId": 1,
    "BaselineBuffer": 3600,
    "TopicType": "ERROR",
    "TopicStatus": "FIXING",
    "HappenTime": 1553524393000,
    "DealTime": 1553524393000,
    "DealUser": "952795****",
    "BaselineName": "基线名称",
    "BaselineId": 1234,
    "NodeName": "节点名称",
    "AlertTime": 1553524393000,
    "Buffer": 1200,
    "Assigner": "952795****",
    "TopicId": 1234,
    "AddTime": 1553524393000,
    "NodeId": 1234
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.该地域还未开放DataWorks的API服务,请尝试其它地域。
500Invalid.Wkbench.ParameterThe specified parameters are invalid.参数错误。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.Wkbench.ServiceErrorAn internal error occurred.服务开小差了。
500Invalid.Wkbench.TopicNotExistThe topic does not exist.事件不存在。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)