Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Modifying a Combined Task
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Combined Task

Function

Modify a combined task.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/{task_id}

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 API Reference.

instance_id

Yes

String

Instance ID.

task_id

Yes

String

Task ID, the unique identifier of a task.

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

description

No

String

Description.

task_tag

No

String

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

operation_types

Yes

Array of strings

Operation type to be supported. You can select multiple operation types. At least one of the following operation types must be selected:

  • INSERT

  • UPDATE

  • DELETE

repulling_snapshot

Yes

Boolean

Whether to synchronize existing data. This parameter is valid only when you edit a task.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Task ID. This parameter can be left empty.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Modify a specified composite data integration task by changing the operation type to insert and update and synchronizing existing data.

{
  "description" : "test",
  "task_tag" : "combinationaa",
  "operation_types" : [ "INSERT", "UPDATE" ],
  "repulling_snapshot" : true
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "FDI.3021",
  "error_msg" : "One or more tasks do not exist."
}

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