更新时间:2024-10-29 GMT+08:00
分享

查询单个任务的日志详情

功能介绍

查询单个任务的所有日志信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/monitor-logs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:1

最大长度:64

instance_id

String

实例ID。

最小长度:1

最大长度:64

task_id

String

任务ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,offset从1开始,取0时行为与1一致。

最小值:0

最大值:999999

缺省值:1

limit

Integer

每页显示条目数量,最大数量999,超过999后只返回999。

最小值:0

最大值:999999

缺省值:10

begin_time

Integer

日志查询的起始时间,格式timestamp(ms),使用UTC时区。

最小值:0

最大值:9999999999999

end_time

Integer

日志查询的结束时间,格式timestamp(ms),使用UTC时区。

最小值:0

最大值:9999999999999

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数。

最小值:1

最大值:99999

size

Integer

当前页日志数量。

最小值:1

最大值:99999

entities

Array of TaskMonitorLog objects

任务监控日志当前页元素。

数组长度:1 - 9999

表5 TaskMonitorLog

参数

参数类型

描述

id

String

单次任务执行的跟踪ID。

最小长度:10

最大长度:40

start_time

Integer

本次执行启动时间,格式timestamp(ms),使用UTC时区。

最小值:1

最大值:9999999999999

dispatch_time

Integer

计划执行时间,格式timestamp(ms),使用UTC时区。

最小值:1

最大值:9999999999999

end_time

Integer

写入结束时间,格式timestamp(ms),使用UTC时区。

最小值:1

最大值:9999999999999

execute_status

String

任务本次执行状态:

  • UNSTARTED(未启动)

  • WAITING(等待调度中)

  • RUNNING(执行中)

  • SUCCESS(执行成功)

  • CANCELLED(任务取消)

  • ERROR(执行异常)

最小长度:3

最大长度:10

position

String

标识本次任务执行到哪一个阶段:

  • ADAPTER(任务处于初始化阶段)

  • READER(任务正在执行Reader读操作)

  • WRITER(任务正在执行Writer写操作)

最小长度:3

最大长度:10

position_status

String

任务本次执行当前阶段的状态:

  • NORMAL(正在运行)

  • NODE_END(本节点正常结束)

  • RUNTIME_CANCEL(任务被取消)

  • TASK_END(本任务正常结束)

  • RUNTIME_ERR(运行时异常)

  • INTERNAL_ERR(内部程序异常)

最小长度:3

最大长度:20

status

Integer

本次任务执行详细状态,状态码划分规则:reader端 100 ~ 499,writer端 500 ~ 899,其他900 ~ :

  • 16(被强制取消)

  • 99(任务开始)

  • 100(Reader 任务开始)

  • 101(Reader 任务结束)

  • 102(正在读取数据)

  • 103(读端数据源端异常)

  • 104(读取数据结束)

  • 105(读取数据为0)

  • 106(读任务强制取消)

  • 107(在reader plugin中,任务发生了中断)

  • 108(读任务恢复运行)

  • 500(Writer 任务开始)

  • 501(Writer 任务结束)

  • 502(正在数据写入)

  • 503(目标端异常)

  • 504(数据写入结束)

  • 505(写任务强制取消)

  • 506(在writer plugin中,任务发生了中断)

  • 507(写任务恢复运行)

  • 900(接收到调度请求)

  • 901(任务运行结束)

  • 902(任务已运行结束,正在进行数据完整性校验)

  • 903(输出数据完整性校验结果)

  • 904(经过数据完整性校验,发现有数据缺失,正在进行数据补偿)

  • 905(输出数据补偿结果)

  • 906(读取任务正在在排队中(平台资源))

  • 907(读取任务被拒绝执行,因为上一次调度还没有结束)

  • 908(写入任务正在在排队中(平台资源))

  • 909(写入任务被拒绝执行,因为上一次调度还没有结束)

  • 911(读取任务没有被正常开启,请检查网络是否通畅,参数是否正确)

  • 912(写入任务没有被正常开启,请检查网络是否通畅,参数是否正确)

  • 913(任务调度请求失败)

  • 914(任务被拒绝执行,因为上一次调度还没有结束)

  • 915(任务不正常运行)

  • 916(任务日志上报异常)

最小值:1

最大值:1000

dirty_data_count

Integer

异常数据条数。

最小值:0

最大值:9999999999999

data_count

Integer

成功数据条数。

最小值:0

最大值:9999999999999

data_size

Number

成功数据大小,浮点数类型。

最小值:0

最大值:9999999999999

data_size_unit

String

成功数据大小的计量单位。

最小长度:1

最大长度:2

spend_time

Integer

执行时长,单位:ms。

最小值:0

最大值:9999999999999

read_spend_time

Integer

读取执行时长,单位:ms,只有在定时任务时存在该属性。

最小值:0

最大值:9999999999999

write_spend_time

Integer

写入执行时长,单位:ms。

最小值:0

最大值:9999999999999

remarks

String

本次执行结果简要信息。

最小长度:0

最大长度:1000

detail_logs

Array of TaskMonitorDetailLog objects

本次执行详细轨迹信息。

数组长度:1 - 9999

表6 TaskMonitorDetailLog

参数

参数类型

描述

id

String

任务每次执行步骤产生的唯一ID。

最小长度:10

最大长度:40

status

Integer

本次任务执行详细状态,状态码划分规则:reader端 100 ~ 499,writer端 500 ~ 899,其他900 ~ :

  • 16(被强制取消)

  • 99(任务开始)

  • 100(Reader 任务开始)

  • 101(Reader 任务结束)

  • 102(正在读取数据)

  • 103(读端数据源端异常)

  • 104(读取数据结束)

  • 105(读取数据为0)

  • 106(读任务强制取消)

  • 107(在reader plugin中,任务发生了中断)

  • 108(读任务恢复运行)

  • 500(Writer 任务开始)

  • 501(Writer 任务结束)

  • 502(正在数据写入)

  • 503(目标端异常)

  • 504(数据写入结束)

  • 505(写任务强制取消)

  • 506(在writer plugin中,任务发生了中断)

  • 507(写任务恢复运行)

  • 900(接收到调度请求)

  • 901(任务运行结束)

  • 902(任务已运行结束,正在进行数据完整性校验)

  • 903(输出数据完整性校验结果)

  • 904(经过数据完整性校验,发现有数据缺失,正在进行数据补偿)

  • 905(输出数据补偿结果)

  • 906(读取任务正在在排队中(平台资源))

  • 907(读取任务被拒绝执行,因为上一次调度还没有结束)

  • 908(写入任务正在在排队中(平台资源))

  • 909(写入任务被拒绝执行,因为上一次调度还没有结束)

  • 911(读取任务没有被正常开启,请检查网络是否通畅,参数是否正确)

  • 912(写入任务没有被正常开启,请检查网络是否通畅,参数是否正确)

  • 913(任务调度请求失败)

  • 914(任务被拒绝执行,因为上一次调度还没有结束)

  • 915(任务不正常运行)

  • 916(任务日志上报异常)

最小值:1

最大值:1000

position

String

标识当前步骤属于哪一个阶段:

  • ADAPTER(任务处于初始化阶段)

  • READER(任务正在执行Reader读操作)

  • WRITER(任务正在执行Writer写操作)

最小长度:3

最大长度:10

position_status

String

任务当前步骤的状态:

  • NORMAL(正在运行)

  • NODE_END(本节点正常结束)

  • RUNTIME_CANCEL(任务被取消)

  • TASK_END(本任务正常结束)

  • RUNTIME_ERR(运行时异常)

  • INTERNAL_ERR(内部程序异常)

最小长度:3

最大长度:20

stage

String

标识当前步骤属于哪一个FDI插件,如adapter、apireader、rdbwriter等。

最小长度:3

最大长度:20

dirty_data_count

Integer

异常数据条数。

最小值:0

最大值:9999999999999

data_count

Integer

成功数据条数。

最小值:0

最大值:9999999999999

data_size

Number

成功数据大小,浮点数类型。

最小值:0

最大值:9999999999999

data_size_unit

String

成功数据大小的计量单位。

最小长度:1

最大长度:2

spend_time

Integer

执行时长,单位:ms。

最小值:0

最大值:9999999999999

remarks

String

执行详细信息。

最小长度:1

最大长度:256

step_begin_time

Integer

本次步骤启动时间,格式timestamp(ms),使用UTC时区。

最小值:1

最大值:9999999999999

step_end_time

Integer

本次步骤结束时间,格式timestamp(ms),使用UTC时区。

最小值:1

最大值:9999999999999

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

OK

{
  "total" : 99999,
  "size" : 99999,
  "entities" : [ {
    "id" : "id123456789",
    "start_time" : 1603243428000,
    "dispatch_time" : 1603243428000,
    "end_time" : 1603243428000,
    "execute_status" : "RUNNING",
    "position" : "READER",
    "position_status" : "NORMAL",
    "status" : 504,
    "dirty_data_count" : 0,
    "data_count" : 100,
    "data_size" : 1000,
    "data_size_unit" : "B",
    "spend_time" : 5000,
    "read_spend_time" : 5000,
    "write_spend_time" : 5000,
    "remarks" : "Task execute success",
    "detail_logs" : [ {
      "id" : "id123456789",
      "status" : 500,
      "position" : "READER",
      "position_status" : "NORMAL",
      "stage" : "adapter",
      "dirty_data_count" : 0,
      "data_count" : 100,
      "data_size" : 1000,
      "data_size_unit" : "B",
      "spend_time" : 5000,
      "remarks" : "task start successfully.",
      "step_begin_time" : 1603243428000,
      "step_end_time" : 1603243428000
    } ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档