Querying the Task Monitoring Information List

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.

Minimum: 1

Maximum: 30

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 30

offset

No

Integer

Offset. The query starts from this offset. The value of offset is greater than or equal to 1.

Minimum: 1

Maximum: 999999

Default: 1

limit

No

Integer

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

Minimum: 0

Maximum: 999999

Default: 10

task_name

No

String

Name of the task to be searched for. Fuzzy search is supported. This parameter is case sensitive and optional. If this parameter is left empty, the system searches for all tasks.

Minimum: 0

Maximum: 100

execute_status

No

String

Execution status of the task to be searched for. This parameter is optional. If it is left empty, the system searches for all tasks.

• UNSTARTED

• WAITING

• RUNNING

• SUCCESS

• CANCELLED

• ERROR

Minimum: 0

Maximum: 10

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

total

Integer

Total number.

Minimum: 1

Maximum: 99999

size

Integer

Number of monitoring records on the current page.

Minimum: 1

Maximum: 99999

entities

Array of TaskMonitorInfo objects

Elements on the current page of task monitoring information.

task_id

String

Task ID.

Minimum: 10

Maximum: 40

task_name

String

Task name.

Minimum: 100

Maximum: 3

task_type

String

Task type.

• REALTIME (real-time)

• TIMING (scheduled)

Minimum: 10

Maximum: 3

status

Integer

Task status:

• 0 (stopped)

• 1 (running)

Minimum: 10

Maximum: 3

last_execute_time

Integer

Latest time when a task is executed. The value is in the format of timestamp(ms) and uses the UTC time zone.

Minimum: 1

Maximum: 999999999999999999

use_quartz_cron

Boolean

Whether a task uses the Quartz expression. This parameter is available only for scheduled tasks.

cron

String

Cron expression. This parameter is available only when the scheduled task is used and use_quartz_cron is set to true.

Minimum: 20

Maximum: 3

period

String

Unit of the scheduling period, such as day and hour. This parameter is available only for scheduled tasks and when use_quartz_cron is set to false.

• MIN (minute)

• HOUR (hour)

• DAY (day)

• WEEK (week)

• MON (month)

Minimum: 5

Maximum: 3

dispatch_interval

Integer

Scheduling period, which is used together with the period field to determine the scheduling interval. This parameter is available only when the scheduled task is used and use_quartz_cron is set to false.

Minimum: 1

Maximum: 60

position

String

Phase to which the latest task is executed.

• ADAPTER (initialization phase)

• READER (reader phase)

• WRITER (writer phase)

Minimum: 10

Maximum: 3

execute_status

String

Last execution status of a task.

• UNSTARTED

• WAITING

• RUNNING

• SUCCESS

• CANCELLED

• ERROR

Minimum: 10

Maximum: 3

source_app_id

String

ID of the application to which the source data source of the task belongs.

Minimum: 1

Maximum: 36

source_app_name

String

Name of the application to which the source data source of the task belongs.

Minimum: 1

Maximum: 256

source_instance_id

String

ID of the instance to which the source data source of the task belongs.

Minimum: 1

Maximum: 60

target_app_id

String

ID of the application to which the destination data source belongs.

Minimum: 1

Maximum: 36

target_app_name

String

Name of the application to which the destination data source belongs.

Minimum: 1

Maximum: 256

target_instance_id

String

ID of the instance to which the destination data source belongs.

Minimum: 1

Maximum: 60

ext_type

String

Extended task type. If the current task is a CDC composite task, the value of this field is CDC. Otherwise, the value is null.

Minimum: 1

Maximum: 10

enterprise_project_id

String

ID of the enterprise project to which the task belongs. The default value is 0.

Minimum: 1

Maximum: 60

task_tag

String

Task tag.

Minimum: 1

Maximum: 256

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

200

OK

400

Bad Request

500

Internal Server Error