更新时间:2022-03-23 GMT+08:00
分享

创建普通任务

功能介绍

创建普通任务(区别于组合任务)

调试

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

URI

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

表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参数

参数

是否必选

参数类型

描述

task

TaskBasicRequestBody object

任务简单信息。

task_detail

String

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

最小长度:1

最大长度:2147483647

表4 TaskBasicRequestBody

参数

是否必选

参数类型

描述

task_name

String

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

最小长度:3

最大长度:100

task_type

String

任务类型

  • REALTIME (实时)

  • TIMING (定时)

最小长度:1

最大长度:10

source_datasource_id

String

源端数据源ID

最小长度:1

最大长度:64

target_datasource_id

String

目标端数据源ID

最小长度:1

最大长度:64

description

String

描述信息

最小长度:1

最大长度:1024

task_tag

String

任务标签,只能包含字母、数字、中划线、下划线

最小长度:4

最大长度:64

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

task

TaskBasicRsp object

任务简单信息。

task_detail

String

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

最小长度:1

最大长度:2147483647

表6 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

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

{
  "task" : {
    "task_name" : "fdi_task_v2mysql-tomysql",
    "task_type" : "TIMING",
    "source_datasource_id" : "30969b205e8f4392a25fb321112d1753",
    "target_datasource_id" : "30969b205e8f4392a25fb321112d1753",
    "description" : "mysql",
    "task_tag" : "fdi_autotest"
  },
  "task_detail" : "{\"sourceSelectedDatasource\":{\"dataTimestamp\":1606807799782,\"isNeedPageSrcApi\":true,\"pageKeySrcApi\":\"pageNum\",\"pageSizeKeySrcApi\":\"pageSize\",\"resultTotalRootPath\":\"\",\"isUseDynamicSignal\":false,\"timeshift\":\"\",\"startTimeKey\":\"\",\"beginDateColSrcApi\":\"beginTime\",\"endDateColSrcApi\":\"endTime\",\"rootPath\":\"\",\"sourceParams\":[{\"keys\":\"pageNum\",\"value\":\"0\"},{\"keys\":\"pageSize\",\"value\":\"10\"},{\"keys\":\"beginTime\",\"value\":\"1\"},{\"keys\":\"endTime\",\"value\":\"1\"}],\"sourceHeaders\":[],\"sourceBodyType\":\"raw-json\",\"bodyRaw\":\"{\\\"pageNum\\\":\\\"1\\\",\\\"pageSize\\\":\\\"10\\\"}\",\"sourceBodyFormData\":[],\"sourceResponseType\":\"json\",\"sourceMetaData\":{\"dataSource\":[{\"index\":0,\"name\":\"name\",\"type\":\"String\",\"format\":\"\",\"path\":\"\"},{\"index\":1,\"name\":\"age\",\"type\":\"Integer\",\"format\":\"\",\"path\":\"\"}],\"mode\":\"keyValue\"},\"incr_migration_type\":\"systemDefault\",\"period_granularity\":\"\",\"period_assignment\":\"\",\"period_right_boarder\":\"\",\"pagingEndType\":\"paging-list\",\"pagingEndFieldPath\":\"\",\"pageNumLimit\":\"1\",\"servicetype\":\"None\",\"current_page_num\":\"1\",\"page_size\":\"10\",\"need_inc_migration\":true,\"date_form\":\"unix_ms\",\"timeZone\":\"GMT+08:00\",\"reset_incr_begin_time\":false,\"compensation_time\":\"0\",\"advanceStartTime\":\"0\",\"advanceStartTimeUnit\":\"day\",\"isParse\":\"true\"},\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"isSupportClearTab\":false,\"targetTable\":\"CDCMODEL.NODE\",\"batchNumber\":\"\",\"targetSelectedColumnList\":[{\"field_name\":\"NODE_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"1\"},{\"field_name\":\"AVAILABILITY_ZONE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"CACHE_PORT\",\"field_type\":\"VARCHAR2\",\"field_length\":\"8\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"FLOATING_IP_ADDRESS\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"NODE_TYPE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"PRIVATE_IP\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"USER_NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"PRIVATE_KEY\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"ROOT_PASSWORD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SERVER_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"STATUS\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SUBNET_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SUBNET_NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"256\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"INSTANCE_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"DATAVOLUME_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"CACHE_ROLE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"RES_SUBNET_IP\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"SYSTEMVOLUME_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"SYSADMIN_PASSWORD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NEW_ROOT_PASSWD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NEW_SYSADMIN_PASSWD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"ROOT_PASSWORD_OVERDUE_TIME\",\"field_type\":\"TIMESTAMP(6)\",\"field_length\":\"0\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"OPERATION_MSG\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"RES_SUBNET_IP_BETA\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"METRIC_DATA\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"}],\"supportPartUpdate\":false},\"mappingTable\":[],\"mappingInput\":{\"dataSource\":[{\"sourceKey\":\"name\",\"targetKey\":\"RES_SUBNET_IP_BETA\"},{\"sourceKey\":\"age\",\"targetKey\":\"METRIC_DATA\"}]},\"mappingRequired\":true,\"error_handler\":{\"path\":\"data1\",\"datasource_id\":\"79c4caaa3e1441dfb0351038fcf5f281\",\"mode\":\"OBS\",\"app_id\":\"73965e3c-72b2-40c3-8335-2154ebd6c23a\",\"stop_task_when_obs_failure\":false},\"afterImplementation\":{\"actionType\":\"KAFKA\",\"appId\":\"73965e3c-72b2-40c3-8335-2154ebd6c23a\",\"datasourceId\":\"a87a31a6288e4698865be122ae485dc0\",\"topic\":\"lgytest99\",\"messageContent\":\"success\"}}"
}

响应示例

状态码: 200

OK

  • 示例 1

    null
  • 示例 2

    {
      "task_id" : "1db6229e0bb34d25ac3fef142d823a7d",
      "task_name" : "fdi_task",
      "task_type" : "timing",
      "project_id" : "c53626012ba84727b938ca8bf03108ef",
      "source_datasource_id" : "525e17795b23431fbe303b90b79c9893",
      "target_datasource_id" : "525e17795b23431fbe303b90b79c9893",
      "source_datasource_name" : "fdi_ds_mysqldingshi",
      "target_datasource_name" : "fdi_ds_mysqldingshi",
      "source_app_id" : "1dfad5a7-464c-40ef-93bd-66a24b12880d",
      "target_app_id" : "1dfad5a7-464c-40ef-93bd-66a24b12880d",
      "status" : "stop",
      "created_date" : 1619404588565
    }
  • 示例 3

    "{\"needAPI\":false,\"targetDsId\":\"525e17795b23431fbe303b90b79c9893\",\"sourceSelectedDatasource\":{\"extend_meta_data\":[],\"orderType\":\"ASC\",\"sourceDateColumn\":\"\",\"dataTimestamp\":\"\",\"sourceTable\":\"gaoxin_test.test_source\",\"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\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"50\",\"field_type\":\"VARCHAR\",\"field_name\":\"picihao\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"19\",\"field_type\":\"DATETIME\",\"field_name\":\"date\"}],\"isParse\":\"true\",\"querySql\":\"\",\"whereOptions\":[],\"instanceId\":\"05173009-2e5f-4773-8303-8e05cc9c9302\",\"sourceMetaData\":{\"dataSource\":[]},\"isAddSql\":false,\"meta_data\":[],\"where\":[],\"need_inc_migration\":false,\"textInputValue\":\"\",\"orderColumn\":\"\",\"isTextInput\":false},\"targetDatasource\":\"fdi_ds_mysqldingshi\",\"needEmailNew\":false,\"description\":\"\",\"mappingTableProperties\":[{\"sourceNullable\":\"0\",\"sourceUnique\":\"1\",\"targetUnique\":\"1\",\"targetNullable\":\"0\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"0\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"}],\"sourceDatasourceType\":\"MYSQL\",\"taskType\":2,\"sourceDatasource\":\"fdi_ds_mysqldingshi\",\"targetDatasourceType\":\"MYSQL\",\"mappingSourceTextOrNot\":[{\"flag\":false},{\"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\"},{\"targetColumnType\":\"TIMESTAMP\",\"isAddDateMapping\":false,\"targetColumnLength\":\"19\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"19\",\"targetColumn\":\"date\",\"sourceColumnType\":\"Datetime\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"date\"}],\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"targetSelectedColumnList\":[{\"null_able\":\"0\",\"unique\":\"1\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"0\",\"unique\":\"0\",\"field_length\":\"255\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"19\",\"field_type\":\"TIMESTAMP\",\"field_name\":\"date\"}],\"supportPartUpdate\":false,\"targetTable\":\"gaoxin_test.test_target\",\"instanceId\":\"05173009-2e5f-4773-8303-8e05cc9c9302\",\"batch_number_style\":\"UUID\",\"isSupportClearTab\":false,\"batchNumber\":\"\"},\"taskName\":\"fdi_task_testaaa_1619433388307\",\"sourceDsId\":\"525e17795b23431fbe303b90b79c9893\",\"projectId\":\"c53626012ba84727b938ca8bf03108ef\",\"needMQS\":false,\"mappingInput\":{},\"mappingRequired\":true}"

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close