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

初始化组合任务

功能介绍

初始化组合任务，分配任务ID，初始化映射等。

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/init

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：1

最大长度：64

instance_id

是

String

实例ID。

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

ext_info

否

ext_info object

扩展属性，目前支持server_id，允许为空。

source_datasource_id

否

String

源端数据源ID。

最小长度：1

最大长度：64

target_datasource_id

否

String

目标端数据源ID。

最小长度：1

最大长度：64

task_id

否

String

任务ID，可以为空，为空时自动分配任务ID。

最小长度：3

最大长度：50

auto_mapping

否

Boolean

是否自动建立源端到目标端映射。
表4 ext_info

参数

是否必选

参数类型

描述

server_id

否

String

Mysql的ServerID

最小长度：1

最大长度：20

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of MultiTaskInitElement objects

OK
表6 MultiTaskInitElement

参数

参数类型

描述

ext_info

ext_info object

扩展属性，目前只支持server_id。

task_id

String

任务ID

最小长度：1

最大长度：64

source_datasource_id

String

源端数据源ID。

最小长度：1

最大长度：64

target_datasource_id

String

目标端数据源ID。

最小长度：1

最大长度：64

source_group

String

源端组。

最小长度：1

最大长度：64

target_group

String

目标端组。

最小长度：1

最大长度：64

source_ds_id

String

源端数据源ID。

最小长度：1

最大长度：64

target_ds_id

String

目标端数据源ID。

最小长度：1

最大长度：64

source_instance_id

String

源端实例ID。

最小长度：1

最大长度：64

target_instance_id

String

目标端实例ID。

最小长度：1

最大长度：64

source_app_id

String

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

最小长度：1

最大长度：64

target_app_id

String

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

最小长度：1

最大长度：64

source_datasource_name

String

源端数据源的名称。

最小长度：1

最大长度：64

target_datasource_name

String

目标端数据源的名称。

最小长度：1

最大长度：64

source_datasource_type

String

源端数据源的类型。

最小长度：1

最大长度：64

target_datasource_type

String

目标端数据源的类型。

最小长度：1

最大长度：64

mappings

Array of MultiTaskMappingElement objects

映射关系列表，只返回前10条。

数组长度：1 - 9999

schema_mappings

Array of MultiTaskSchemaMappingElement objects

schema映射关系列表，只返回前10条。

数组长度：1 - 9999

mappings_total_count

Integer

映射关系总数

最小值：0

最大值：1000000
表7 ext_info

参数

参数类型

描述

server_id

String

MySQL的ServerID。

最小长度：1

最大长度：20
表8 MultiTaskMappingElement

参数

参数类型

描述

id

String

映射唯一ID。

最小长度：1

最大长度：64

source_table

String

源表名。

最小长度：1

最大长度：256

target_table

String

目标表名。

最小长度：1

最大长度：256

updated_time

Long

上次修改时间。

最小值：1

最大值：9999999999999999999

mapping_percent

Integer

匹配度。

最小值：0

最大值：100

status

String

映射状态。

  • AUTO (自动映射)

  • MANUAL (手工新增)

  • ADD (自动新增)

  • UPDATE (更新)

  • DELETE (删除)

  • USING (使用中)

最小长度：1

最大长度：10

source_columns

Array of MultiTaskColumnInfo objects

源端字段列表。

数组长度：1 - 9999

target_columns

Array of MultiTaskColumnInfo objects

目标端字段列表。

数组长度：1 - 9999

mapping

Array of MappingInfo objects

字段映射列表。

数组长度：1 - 9999
表9 MultiTaskColumnInfo

参数

参数类型

描述

field_name

String

字段名。

最小长度：1

最大长度：256

field_type

String

字段类型。

最小长度：1

最大长度：256

field_length

String

字段长度。

最小值：0

最大值：10000000
表10 MappingInfo

参数

参数类型

描述

source_column

String

源端字段。

最小长度：1

最大长度：256

source_column_type

String

源端字段类型。

最小长度：1

最大长度：256

source_column_length

String

源端字段长度。

最小值：0

最大值：10000000

target_column

String

目标端字段。

最小长度：1

最大长度：256

target_column_type

String

目标端字段类型。

最小长度：1

最大长度：256

target_column_length

String

目标端字段长度。

最小值：0

最大值：10000000
表11 MultiTaskSchemaMappingElement

参数

参数类型

描述

id

String

映射唯一ID。

最小长度：1

最大长度：64

source_schema

String

源schema名。

最小长度：1

最大长度：256

target_schema

String

目标schema名。

最小长度：1

最大长度：256

updated_time

Long

上次修改时间。

最小值：1

最大值：9999999999999999999

status

String

映射状态。

  • AUTO (自动映射)

  • MANUAL (手工新增)

  • ADD (自动新增)

  • UPDATE (更新)

  • DELETE (删除)

  • USING (使用中)

最小长度：1

最大长度：10

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

根据指定源端和目标端数据源初始化组合任务

{
  "ext_info" : null,
  "source_datasource_id" : "30969b205e8f4392a25fb321112d1753",
  "target_datasource_id" : "30969b205e8f4392a25fb321112d1753",
  "task_id" : null,
  "auto_mapping" : false
}

响应示例

状态码： 400

Bad Request

{
  "error_code" : "FDI.3150",
  "error_msg" : "The task list is empty."
}

状态码： 404

Not Found

{
  "error_code" : "FDI.3083",
  "error_msg" : "One or more scheduled tasks are not configured with scheduled plans."
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务管理