文档首页> 应用与数据集成平台 ROMA Connect> API参考> 数据集成API> 任务管理> 查询任务列表
更新时间：2022-03-23 GMT+08:00
查看PDF
分享

查询任务列表

功能介绍

查询任务列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：1

最大长度：64

instance_id

是

String

实例ID

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

分页查询，每页显示的条目数量，最大数量1000

最小值：0

最大值：1000

offset

否

Integer

分页查询，分页的偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

最小值：0

最大值：20000

task_id

否

String

任务ID，可为空

最小长度：1

最大长度：64

taks_name

否

String

模糊匹配任务名称，可为空

最小长度：1

最大长度：64

status

否

Integer

任务状态，可为空

  • 0 （停止/未启动）

  • 1 （运行中）

最小值：0

最大值：1

task_type

否

String

任务类型

  • realtime (实时)

  • timing (定时)

最小长度：0

最大长度：10

source_datasource_id

否

String

源端数据源ID，可为空

最小长度：1

最大长度：64

target_datasource_id

否

String

目标端数据源ID，可为空

最小长度：1

最大长度：64

datasource_id

否

String

源端或者目标数据源ID，可为空

最小长度：1

最大长度：64

sort_field

否

String

查询排序的条件

  • CREATED_DATE (创建日期)

  • STATUS (状态)

最小长度：1

最大长度：64

sort_type

否

String

排序类型，可为空

  • ASC (升序)

  • DESC (降序)

最小长度：1

最大长度：10

execute_status

否

String

执行状态，可为空

  • UNSTARTED (未启动)

  • WAITING (等待执行)

  • RUNNING (执行中)

  • SUCCESS (执行成功)

  • CANCELLED (任务取消)

  • ERROR (执行异常)

最小长度：1

最大长度：64

source_app_id

否

String

源端数据源所属集成应用ID，可为空

最小长度：1

最大长度：64

target_app_id

否

String

目标端数据源所属集成应用ID，可为空

最小长度：1

最大长度：64

task_tag

否

String

任务标签，可为空

最小长度：0

最大长度：64

task_mode

否

String

任务模式，如果为空查询所有任务

  • NORMAL (普通任务)

  • CDC (组合任务)

  • FLOW (编排任务)

最小长度：0

最大长度：6

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Long

查询任务列表任务总个数

最小值：0

最大值：1000000

size

Integer

查询任务列表返回的当前页的任务个数

最小值：0

最大值：1000

entities

Array of BriefTaskRespBean objects

查询任务列表返回的对象
表5 BriefTaskRespBean

参数

参数类型

描述

task_id

String

任务ID

最小长度：1

最大长度：64

task_name

String

任务名称

最小长度：1

最大长度：64

task_type

String

任务类型

  • REALTIME (实时)

  • TIMING (定时)

最小长度：1

最大长度：10

status

Integer

任务状态

  • 0 (停止/未启动)

  • 1 (运行中)

最小值：0

最大值：1

created_date

String

创建时间

version

String

任务的版本

最小长度：0

最大长度：10

last_modified_time

Long

上次修改时间

最小值：1

最大值：9999999999999999999

execute_status

String

任务执行状态

  • UNSTARTED (未启动)

  • WAITING (等待执行)

  • RUNNING (执行中)

  • SUCCESS (执行成功)

  • CANCELLED (任务取消)

  • ERROR (执行异常)

最小长度：1

最大长度：64

source_app_id

String

源端数据源所属应用ID

最小长度：1

最大长度：64

target_app_id

String

目标端数据源所属应用ID

最小长度：1

最大长度：64

source_instance_id

String

源端实例ID

最小长度：1

最大长度：64

target_instance_id

String

目标端实例ID

最小长度：1

最大长度：64

ext_type

String

组合任务类型, 可为空

最小长度：1

最大长度：64

enterprise_project_id

String

企业项目id

最小长度：1

最大长度：64

task_tag

String

任务标签

最小长度：1

最大长度：64

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

无

响应示例

状态码： 200

OK

  • 示例 1

    null

  • 示例 2

    "100,"

  • 示例 3

    "1,"

  • 示例 4

    [ {
  "task_id" : "1db6229e0bb34d25ac3fef142d823a7d",
  "task_name" : "fdi_task_testaaa_1619433388307",
  "task_type" : "timing",
  "status" : 0,
  "start_datetime" : 1618995296086,
  "use_quartz_cron" : false,
  "execute_status" : "UNSTARTED",
  "source_app_id" : "1dfad5a7-464c-40ef-93bd-66a24b12880d",
  "target_app_id" : "1dfad5a7-464c-40ef-93bd-66a24b12880d",
  "source_app_name" : "app-gxtest_1619433387457",
  "target_app_name" : "app-gxtest_1619433387457",
  "source_instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302",
  "target_instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302",
  "enterprise_project_id" : "0",
  "source_ds_id" : "525e17795b23431fbe303b90b79c9893",
  "source_ds_type" : "MYSQL",
  "source_ds_name" : "fdi_ds_mysqldingshi",
  "target_ds_id" : "525e17795b23431fbe303b90b79c9893",
  "target_ds_type" : "MYSQL",
  "target_ds_name" : "fdi_ds_mysqldingshi",
  "version" : "1",
  "task_mode" : "NORMAL"
} ]

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务管理
分享：

    相关文档

    相关产品

close