Updated on 2025-03-26 GMT+08:00

Querying the Log Details of a Single Task

Function

This API is used to query all logs of a task.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

task_id

Yes

String

Task ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, where the query starts. The value starts from 1 (the value 0 is treated as 1).

limit

No

Integer

Number of records displayed on each page. The maximum value is 999. Excessive records are not returned.

begin_time

No

Integer

Start time for the logs to be queried. The value is in the format of timestamp(ms) and uses the UTC time zone.

end_time

No

Integer

End time for the logs to be queried. The value is in the format of timestamp(ms) and uses the UTC time zone.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number.

size

Integer

Number of logs on the current page.

entities

Array of TaskMonitorLog objects

Elements on the current page of task monitoring logs.

Table 5 TaskMonitorLog

Parameter

Type

Description

id

String

Trace ID of a single task.

start_time

Integer

Start time of the current execution. The value is in the format of timestamp(ms) and uses the UTC time zone.

dispatch_time

Integer

Scheduled execution time. The value is in the format of timestamp(ms) and uses the UTC time zone.

end_time

Integer

End time of the current execution. The value is in the format of timestamp(ms) and uses the UTC time zone.

execute_status

String

Task execution status.

  • UNSTARTED

  • WAITING

  • RUNNING

  • SUCCESS

  • CANCELLED

  • ERROR

position

String

Phase to which the task is executed.

  • ADAPTER (initialization phase)

  • READER (reader phase)

  • WRITER (writer phase)

position_status

String

Status of the current task execution phase.

  • NORMAL (currently running)

  • NODE_END (current node ends normally)

  • RUNTIME_CANCEL (task canceled)

  • TASK_END (current task ends normally)

  • RUNTIME_ERR (runtime error)

  • INTERNAL_ERR (internal program error)

status

Integer

Detailed task execution status. The status codes are classified as follows: 100 to 499 for the reader side, 500 to 899 for the writer side, and 900 and beyond for others.

  • 16 (task forcibly canceled)

  • 99 (task starts)

  • 100 (reader task starts)

  • 101 (reader task ends)

  • 102 (reading data)

  • 103 (reading data source exception)

  • 104 (reading data ends)

  • 105 (0 reading data)

  • 106 (reading task forcibly canceled)

  • 107 (task interrupted in the reader plugin)

  • 108 (reader task resumes)

  • 500 (writer task starts)

  • 501 (writer task ends)

  • 502 (data being written)

  • 503 (destination exception)

  • 504 (data writing ends)

  • 505 (writer task forcibly canceled)

  • 506 (task interrupted in the writer plugin)

  • 507 (writer task resumed)

  • 900 (scheduling request received)

  • 901 (task execution ends)

  • 902 (task execution ends and data integrity check is being performed)

  • 903 (output data integrity check results)

  • 904 (Data loss detected after data integrity check. Data compensation is being performed.)

  • 905 (output data compensation results)

  • 906 (reader tasks being queued (platform resources))

  • 907 (reader tasks rejected because last scheduling not completed yet)

  • 908 (writer tasks being queued (platform resources))

  • 909 (writer task rejected because last scheduling not completed yet)

  • 911 (Reader task not started normally. Check whether the network is normal and whether the parameters are correct.)

  • 912 (Writer task not started normally. Check whether the network is normal and whether the parameters are correct.)

  • 913 (task scheduling request failure)

  • 914 (task rejected because last scheduling not completed yet)

  • 915 (task not running properly)

  • 916 (task log report abnormal)

dirty_data_count

Integer

Number of abnormal data records.

data_count

Integer

Number of successful data records.

data_size

Number

Size of success data. The value is a floating-point number.

data_size_unit

String

Unit for measuring the size of success data.

spend_time

Integer

Execution duration, in milliseconds.

read_spend_time

Integer

Read execution duration, in milliseconds. This parameter is available only for scheduled tasks.

write_spend_time

Integer

Write execution duration, in milliseconds.

remarks

String

Brief information about the execution result.

detail_logs

Array of TaskMonitorDetailLog objects

Detailed track information about the current execution.

Table 6 TaskMonitorDetailLog

Parameter

Type

Description

id

String

Unique ID generated each time when a task is executed.

status

Integer

Detailed task execution status. The status codes are classified as follows: 100 to 499 for the reader side, 500 to 899 for the writer side, and 900 and beyond for others.

  • 16 (task forcibly canceled)

  • 99 (task starts)

  • 100 (reader task starts)

  • 101 (reader task ends)

  • 102 (reading data)

  • 103 (reading data source exception)

  • 104 (reading data ends)

  • 105 (0 reading data)

  • 106 (reading task forcibly canceled)

  • 107 (task interrupted in the reader plugin)

  • 108 (reader task resumes)

  • 500 (writer task starts)

  • 501 (writer task ends)

  • 502 (data being written)

  • 503 (destination exception)

  • 504 (data writing ends)

  • 505 (writer task forcibly canceled)

  • 506 (task interrupted in the writer plugin)

  • 507 (writer task resumed)

  • 900 (scheduling request received)

  • 901 (task execution ends)

  • 902 (task execution ends and data integrity check is being performed)

  • 903 (output data integrity check results)

  • 904 (Data loss detected after data integrity check. Data compensation is being performed.)

  • 905 (output data compensation results)

  • 906 (reader tasks being queued (platform resources))

  • 907 (reader tasks rejected because last scheduling not completed yet)

  • 908 (writer tasks being queued (platform resources))

  • 909 (writer task rejected because last scheduling not completed yet)

  • 911 (Reader task not started normally. Check whether the network is normal and whether the parameters are correct.)

  • 912 (Writer task not started normally. Check whether the network is normal and whether the parameters are correct.)

  • 913 (task scheduling request failure)

  • 914 (task rejected because last scheduling not completed yet)

  • 915 (task not running properly)

  • 916 (task log report abnormal)

position

String

Phase at which the current step is.

  • ADAPTER (initialization phase)

  • READER (reader phase)

  • WRITER (writer phase)

position_status

String

Status of the current step of a task.

  • NORMAL (currently running)

  • NODE_END (current node ends normally)

  • RUNTIME_CANCEL (task canceled)

  • TASK_END (current task ends normally)

  • RUNTIME_ERR (runtime error)

  • INTERNAL_ERR (internal program error)

stage

String

FDI plug-in to which the current step belongs, for example, adapter, apireader, and rdbwriter.

dirty_data_count

Integer

Number of abnormal data records.

data_count

Integer

Number of successful data records.

data_size

Number

Size of success data. The value is a floating-point number.

data_size_unit

String

Unit for measuring the size of success data.

spend_time

Integer

Execution duration, in milliseconds.

remarks

String

Execution details.

step_begin_time

Integer

Start time of this step. The value is in the format of timestamp(ms) and uses the UTC time zone.

step_end_time

Integer

End time of this step. The value is in the format of timestamp(ms) and uses the UTC time zone.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 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
    } ]
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.