Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Creating a Common Task
Updated on 2025-07-18 GMT+08:00
View PDF

Creating a Common Task

Function

This API is used to create a common task (different from a composite task).

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

task

Yes

TaskBasicRequestBody object

Brief information about a task.

task_detail

Yes

String

Task details. For details about the parameter structure, see Data Integration Parameter Description > RawFormDataRequest in the Appendix.
Table 4 TaskBasicRequestBody

Parameter

Mandatory

Type

Description

task_name

Yes

String

Task name. The value contains 3 to 100 characters, consisting of only letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter or digit.

task_type

Yes

String

Task type.

  • REALTIME

  • TIMING (scheduled)

source_datasource_id

Yes

String

Data source ID at the source.

target_datasource_id

Yes

String

Data source ID at the destination.

description

No

String

Description.

task_tag

No

String

Task tag, which can contain only letters, digits, hyphens (-), and underscores (_).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task

TaskBasicRsp object

Brief information about a task.

task_detail

String

Task details. For details about the parameter structure, see Data Integration Parameter Description > RawFormDataResponse in the Appendix.
Table 6 TaskBasicRsp

Parameter

Type

Description

task_id

String

Task ID. This parameter can be left empty.

task_name

String

Task name. The value contains 3 to 100 characters, consisting of only letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter or digit.

task_type

String

Task type.

  • realtime (real-time)

  • timing (scheduled)

status

String

Task status.

  • stopped

  • running

project_id

String

Project ID.

source_datasource_id

String

Data source ID at the source.

target_datasource_id

String

Data source ID at the destination.

source_datasource_name

String

Name of the source data source.

target_datasource_name

String

Name of the destination data source.

source_app_id

String

ID of the integration application to which the source data source belongs.

target_app_id

String

ID of the integration application to which the destination data source belongs.

source_app_name

String

Name of the integration application to which the source data source belongs.

target_app_name

String

Name of the integration application to which the destination data source belongs.

created_date

Integer

Date created.

last_modified_date

Integer

Last modification time.

description

String

Description. This parameter is not displayed when the request parameter is empty.

task_tag

String

Task tag, which can contain only letters, digits, hyphens (-), and underscores (_). This parameter is not displayed when the request parameter is empty.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Create a common data integration task with its task type as scheduled, and manually configure the mapping.

{
  "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\"}}"
}

Example Responses

Status code: 200

OK

{
  "task" : {
    "task_id" : "15366328208d4d77b76532fe9f4006a6",
    "task_name" : "fdi_task_v2mysql-tomysql",
    "task_type" : "timing",
    "status" : "stop",
    "project_id" : "c53626012ba84727b938ca8bf03108ef",
    "source_datasource_id" : "30969b205e8f4392a25fb321112d1753",
    "target_datasource_id" : "30969b205e8f4392a25fb321112d1753",
    "source_datasource_name" : "fdi_ds_testmysqlv2",
    "target_datasource_name" : "fdi_ds_testmysqlv2",
    "source_app_id" : "eaaa8ad0-f967-416a-ab73-d995ef656e89",
    "target_app_id" : "eaaa8ad0-f967-416a-ab73-d995ef656e89",
    "source_app_name" : "app-testV2-interface",
    "target_app_name" : "app-testV2-interface",
    "created_date" : 1605288733684,
    "last_modified_date" : 1605288733684,
    "description" : "crate task",
    "task_tag" : "fdi_autotest"
  },
  "task_detail" : "{\"needAPI\":false,\"targetDsId\":\"7049282e5678490d8e5a5c55d77638f6\",\"sourceSelectedDatasource\":{\"extend_meta_data\":[],\"orderType\":\"ASC\",\"sourceDateColumn\":\"\",\"dataTimestamp\":\"\",\"sourceTable\":\"mydb.tb_tmp01\",\"sourceSelectedColumnList\":[{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"25\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"deptId\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"age\"}],\"isParse\":\"true\",\"querySql\":\"\",\"whereOptions\":[],\"instanceId\":\"02a7726e-1fc2-44b5-ae96-84a2b5f0e660\",\"sourceMetaData\":{\"dataSource\":[]},\"isAddSql\":false,\"meta_data\":[],\"where\":[],\"need_inc_migration\":false,\"textInputValue\":\"\",\"orderColumn\":\"\",\"isTextInput\":false},\"targetDatasource\":\"mysql\",\"needEmailNew\":false,\"description\":\"\",\"taskTag\":\"\",\"mappingTableProperties\":[{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"}],\"sourceDatasourceType\":\"MYSQL\",\"taskType\":2,\"sourceDatasource\":\"mysql\",\"targetDatasourceType\":\"MYSQL\",\"mappingSourceTextOrNot\":[{\"flag\":false},{\"flag\":false},{\"flag\":false},{\"flag\":false}],\"mappingTable\":[{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"sourceSupport\":\"1\",\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"id\",\"sourceColumnType\":\"INT\",\"targetSupport\":\"1\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"id\"},{\"targetColumnType\":\"VARCHAR\",\"isAddDateMapping\":false,\"sourceSupport\":\"1\",\"targetColumnLength\":\"25\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"25\",\"targetColumn\":\"name\",\"sourceColumnType\":\"VARCHAR\",\"targetSupport\":\"1\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"name\"},{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"sourceSupport\":\"1\",\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"deptId\",\"sourceColumnType\":\"INT\",\"targetSupport\":\"1\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"deptId\"},{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"sourceSupport\":\"1\",\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"age\",\"sourceColumnType\":\"INT\",\"targetSupport\":\"1\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"age\"}],\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"targetSelectedColumnList\":[{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"25\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"deptId\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"age\"}],\"supportPartUpdate\":false,\"targetTable\":\"mydb.tb_tmp01_target\",\"instanceId\":\"02a7726e-1fc2-44b5-ae96-84a2b5f0e660\",\"batch_number_style\":\"UUID\",\"isSupportClearTab\":false,\"batchNumber\":\"\"},\"taskName\":\"fdi_task_5ykjp7\",\"sourceDsId\":\"7049282e5678490d8e5a5c55d77638f6\",\"projectId\":\"c53626012ba84727b938ca8bf03108ef\",\"needMQS\":false,\"mappingInput\":{},\"mappingRequired\":true}"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Task Management