文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 数据集成API/ 任务管理/ 查询指定任务的信息
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定任务的信息

功能介绍

通过任务ID查询指定任务的信息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：1

最大长度：64

instance_id

是

String

实例ID。

最小长度：1

最大长度：64

task_id

是

String

任务唯一标识，任务的ID。

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

task

TaskBasicRsp object

任务简单信息。

task_detail

String

任务详细信息。参数结构参照附录中“数据集成参数说明>RawFormDataResponse”章节。

最小长度：1

最大长度：2147483647
表4 TaskBasicRsp

参数

参数类型

描述

task_id

String

任务ID, 可为空。

最小长度：1

最大长度：64

task_name

String

任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。

最小长度：3

最大长度：100

task_type

String

任务类型。

  • realtime (实时)

  • timing (定时)

最小长度：1

最大长度：10

status

String

任务状态。

  • stop (停止\未启动)

  • running (运行中)

最小值：0

最大值：1

project_id

String

项目ID。

最小长度：1

最大长度：64

source_datasource_id

String

源端数据源ID。

最小长度：1

最大长度：64

target_datasource_id

String

目标端数据源ID。

最小长度：1

最大长度：64

source_datasource_name

String

源端数据源的名称。

最小长度：1

最大长度：64

target_datasource_name

String

目标端数据源的名称。

最小长度：1

最大长度：64

source_app_id

String

源端数据源所属集成应用ID。

最小长度：1

最大长度：64

target_app_id

String

目标端数据源所属集成应用ID。

最小长度：1

最大长度：64

source_app_name

String

源端数据源所属集成应用名称。

最小长度：1

最大长度：64

target_app_name

String

目标端数据源所属集成应用名称。

最小长度：1

最大长度：64

created_date

Integer

创建时间。

最小值：0

最大值：99999999999999999999

last_modified_date

Integer

最近一次的修改时间。

最小值：0

最大值：99999999999999999999

description

String

描述信息，请求参数为空时不显示。

最小长度：1

最大长度：1024

task_tag

String

任务标签，只能包含字母、数字、中划线、下划线，请求参数为空时不显示。

最小长度：4

最大长度：64

状态码： 404

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

查询指定数据集成任务的任务详情

https://{{ServerHost}}/v2/c53626012ba84727b938ca8bf03108ef/fdi/instances/fae7ff6c-8e07-4cf8-9e67-589cab2f017c/tasks/15366328208d4d77b76532fe9f4006a6

响应示例

状态码： 200

OK

{
  "task" : {
    "task_id" : "9496207a5d6b44b486d79005b5815bd4",
    "task_name" : "fdi_task_pzy4m5",
    "task_type" : "timing",
    "project_id" : "c53626012ba84727b938ca8bf03108ef",
    "source_datasource_id" : "d3412230cff8449e92c8ff8f74d1157d",
    "target_datasource_id" : "d3412230cff8449e92c8ff8f74d1157d",
    "source_datasource_name" : "100.85.221.77",
    "target_datasource_name" : "100.85.221.77",
    "source_app_id" : "7f245167-ac84-4b2e-bbea-f0988a4bf6f4",
    "target_app_id" : "7f245167-ac84-4b2e-bbea-f0988a4bf6f4",
    "source_app_name" : "app-fdi-ttt",
    "target_app_name" : "app-fdi-ttt",
    "status" : "stop",
    "created_date" : 1666772375897,
    "last_modified_date" : 1666772375897,
    "task_mode" : "NORMAL",
    "enterprise_project_id" : "0",
    "source_datasource_type" : "MYSQL",
    "target_datasource_type" : "MYSQL",
    "source_instance_name" : "roma-z00617033-not-delete",
    "target_instance_name" : "roma-z00617033-not-delete",
    "execute_status" : "SUCCESS",
    "repulling_snapshot" : false
  },
  "task_detail" : "{\"needAPI\":false,\"targetDsId\":\"d3412230cff8449e92c8ff8f74d1157d\",\"sourceSelectedDatasource\":{\"extend_meta_data\":[],\"orderType\":\"ASC\",\"sourceDateColumn\":\"\",\"dataTimestamp\":\"\",\"sourceTable\":\"zhenghaotest.zh_sss01\",\"sourceSelectedColumnList\":[{\"null_able\":\"0\",\"unique\":\"1\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"255\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"}],\"isParse\":\"true\",\"querySql\":\"\",\"whereOptions\":[],\"instanceId\":\"db93bfe1-c660-4c9e-82b6-388e44662cc8\",\"sourceMetaData\":{\"dataSource\":[]},\"isAddSql\":false,\"meta_data\":[],\"where\":[],\"need_inc_migration\":false,\"textInputValue\":\"\",\"orderColumn\":\"\",\"isTextInput\":false},\"targetDatasource\":\"100.85.221.77\",\"needEmailNew\":false,\"description\":\"\",\"taskTag\":\"\",\"mappingTableProperties\":[{\"sourceNullable\":\"0\",\"sourceUnique\":\"1\",\"targetUnique\":\"1\",\"targetNullable\":\"0\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"}],\"sourceDatasourceType\":\"MYSQL\",\"taskType\":2,\"sourceDatasource\":\"100.85.221.77\",\"targetDatasourceType\":\"MYSQL\",\"mappingSourceTextOrNot\":[{\"flag\":false},{\"flag\":false}],\"mappingTable\":[{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"id\",\"sourceColumnType\":\"INT\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"id\"},{\"targetColumnType\":\"VARCHAR\",\"isAddDateMapping\":false,\"targetColumnLength\":\"255\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"255\",\"targetColumn\":\"name\",\"sourceColumnType\":\"VARCHAR\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"name\"}],\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"targetSelectedColumnList\":[{\"null_able\":\"0\",\"unique\":\"1\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"255\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"64\",\"field_type\":\"VARCHAR\",\"field_name\":\"bunum\"}],\"supportPartUpdate\":false,\"targetTable\":\"zhenghaotest.zh_sss02\",\"instanceId\":\"db93bfe1-c660-4c9e-82b6-388e44662cc8\",\"batch_number_style\":\"UUID\",\"isSupportClearTab\":false,\"batchNumber\":\"\"},\"taskName\":\"fdi_task_pzy4m5\",\"sourceDsId\":\"d3412230cff8449e92c8ff8f74d1157d\",\"projectId\":\"c53626012ba84727b938ca8bf03108ef\",\"needMQS\":false,\"mappingInput\":{},\"mappingRequired\":true}"
}

状态码

状态码

描述

200

OK

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务管理

相关文档