Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Starting or Stopping Tasks in Batches
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Starting or Stopping Tasks in Batches

Function

This API is used to start or stop tasks in batches.

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

POST /v2/{project_id}/fdi/instances/{instance_id}/batch-operation/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 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

action_id

Yes

String

Operation type.

  • start

  • stop

list

No

Array of TaskBean objects

IDs of tasks to be started or stopped. The maximum length of the list array is 10.
Table 4 TaskBean

Parameter

Mandatory

Type

Description

task_id

No

String

Task ID. This parameter can be left empty.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

success_count

Integer

Success count.

failure_count

Integer

Failure count.

failure

Array of TaskBeanFacade objects

Failure details.

success

Array of TaskBeanFacade objects

Information about successful tasks.
Table 6 TaskBeanFacade

Parameter

Type

Description

task_id

String

Task ID.

task_name

String

Task name.

error_code

String

Error code.

error_msg

String

Error details.

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

Start data integration tasks in batches.

{
  "action_id" : "start",
  "list" : [ {
    "task_id" : "49460e99d597464d885f871dd6acc894"
  } ]
}

Example Responses

Status code: 400

Bad Request

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

Status code: 404

Not Found

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

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