调用ListTopics获取或搜索事件列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTopics

要执行的操作。

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

起始发现时间,需要使用UTC格式(yyyy-MM-dd'T'HH:mm:ssZ)。

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

截止发现时间,需要使用UTC格式(yyyy-MM-dd'T'HH:mm:ssZ)。

PageNumber Integer 1

分页的页数。默认值为1,最小值为1,最大值为30。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

RegionId String cn-shanghai

可用区的唯一标识。

TopicTypes String ERROR,SLOW

事件的类型,包括SLOW(变慢)和ERROR(出错)。多个事件类型之间使用英文逗号(,)分隔。

TopicStatuses String IGNORE,NEW,FIXING,RECOVER

事件的状态,包括IGNORE(已忽略)、NEW(新发现)、FIXING(处理中)和RECOVER(已恢复)。多个事件状态之间使用英文逗号(,)分隔。

NodeId Long 1234

事件关联的任务节点ID,与参数InstanceId互斥。

InstanceId Long 12345

事件关联的实例ID,与参数NodeId互斥。

Owner String 952795****

事件责任人的阿里云UID。

返回数据

名称 类型 示例值 描述
Data Struct

返回的事件列表。

PageNumber Integer 1

当前的页数。

PageSize Integer 10

每页的大小。

Topics Array of Topics

事件列表。

AddTime Long 1553524393000

事件发现的时间戳。

FixTime Long 1553508465000

事件恢复的时间戳。

HappenTime Long 1553508465000

事件发生的时间戳,事件发生和被发现存在一定的时间差。

InstanceId Long 12345

事件关联的实例ID。

NodeId Long 1234

事件关联的任务节点ID。

NodeName String 节点名称

任务节点的名称。

NodeOwner String 952795****

任务节点责任人的阿里云UID

ProjectId Long 1234

任务节点所在工作空间的ID。

TopicId Long 1234

事件的ID。

TopicName String 1234出错

事件的名称。

TopicStatus String NEW

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

TopicType String ERROR

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

TotalCount Integer 100

事件的总数。

ErrorCode String 1031203110005

错误码。

ErrorMessage String The specified parameters are invalid.

错误信息。

HttpStatusCode Integer 200

HTTP返回码。

RequestId String 0000-ABCD-EFG****

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

Success Boolean true

调用是否成功。

示例

请求示例

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
&<公共请求参数>

正常返回示例

XML 格式

<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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
        <TopicId>1234</TopicId>
        <TopicStatus>NEW</TopicStatus>
        <AddTime>1553524393000</AddTime>
        <HappenTime>1553508465000</HappenTime>
        <TopicName>1234出错</TopicName>
    </Topics>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. 该地域还未开放DataWorks的API服务,请尝试其它地域。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.Wkbench.ServiceError An internal error occurred. 服务开小差了。
500 Invalid.Wkbench.Parameter The specified parameters are invalid. 参数错误。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. 对该资源的请求已超过您的每日可用上限。
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. 该资源已经达到您的使用上限,请提交工单进行咨询。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。

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