初始化组合任务 - InstallMultiTasks
功能介绍
初始化组合任务,分配任务ID,初始化映射等。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/init
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
| instance_id | 是 | String | 实例ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ext_info | 否 | ext_info object | 扩展属性,目前支持server_id,允许为空。 |
| source_datasource_id | 否 | String | 源端数据源ID。 |
| target_datasource_id | 否 | String | 目标端数据源ID。 |
| task_id | 否 | String | 任务ID,可以为空,为空时自动分配任务ID。 |
| auto_mapping | 否 | Boolean | 是否自动建立源端到目标端映射。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of MultiTaskInitElement objects | 组合任务初始化响应体 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| ext_info | ext_info object | 扩展属性,目前只支持server_id。 |
| task_id | String | 任务ID |
| source_datasource_id | String | 源端数据源ID。 |
| target_datasource_id | String | 目标端数据源ID。 |
| source_group | String | 源端组。 |
| target_group | String | 目标端组。 |
| source_ds_id | String | 源端数据源ID。 |
| target_ds_id | String | 目标端数据源ID。 |
| source_instance_id | String | 源端实例ID。 |
| target_instance_id | String | 目标端实例ID。 |
| source_app_id | String | 源端数据源所属集成应用ID。 |
| target_app_id | String | 目标端数据源所属集成应用ID。 |
| source_datasource_name | String | 源端数据源的名称。 |
| target_datasource_name | String | 目标端数据源的名称。 |
| source_datasource_type | String | 源端数据源的类型。 |
| target_datasource_type | String | 目标端数据源的类型。 |
| mappings | Array of MultiTaskMappingElement objects | 映射关系列表,只返回前10条。 |
| schema_mappings | Array of MultiTaskSchemaMappingElement objects | schema映射关系列表,只返回前10条。 |
| mappings_total_count | Integer | 映射关系总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 映射唯一ID。 |
| source_table | String | 源表名。 |
| target_table | String | 目标表名。 |
| updated_time | Long | 上次修改时间。 |
| mapping_percent | Integer | 匹配度。 |
| status | String | 映射状态。
|
| source_columns | Array of MultiTaskColumnInfo objects | 源端字段列表。 |
| target_columns | Array of MultiTaskColumnInfo objects | 目标端字段列表。 |
| mapping | Array of MappingInfo objects | 字段映射列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| field_name | String | 字段名。 |
| field_type | String | 字段类型。 |
| field_length | String | 字段长度。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| source_column | String | 源端字段。 |
| source_column_type | String | 源端字段类型。 |
| source_column_length | String | 源端字段长度。 |
| target_column | String | 目标端字段。 |
| target_column_type | String | 目标端字段类型。 |
| target_column_length | String | 目标端字段长度。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 映射唯一ID。 |
| source_schema | String | 源schema名。 |
| target_schema | String | 目标schema名。 |
| updated_time | Long | 上次修改时间。 |
| status | String | 映射状态。
|
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
根据指定源端和目标端数据源初始化组合任务
{
"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 |
错误码
请参见错误码。