On this page

Show all

Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Starting or Stopping Tasks in Batches

Starting or Stopping Tasks in Batches

Updated on 2023-06-29 GMT+08:00

View PDF

Function

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

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 ROMA Connect API Reference. Minimum: 1 Maximum: 64
instance_id	Yes	String	Instance ID. Minimum: 1 Maximum: 64

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 Minimum: 1 Maximum: 10
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. Minimum: 1 Maximum: 64

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
success_count	Integer	Success count. Minimum: 0 Maximum: 999999
failure_count	Integer	Failure count. Minimum: 0 Maximum: 999999
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. Minimum: 1 Maximum: 64
task_name	String	Task name. Minimum: 1 Maximum: 64
error_code	String	Error code. Minimum: 0 Maximum: 64
error_msg	String	Error details. Minimum: 1 Maximum: 64

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 36
error_msg	String	Error message. Minimum: 2 Maximum: 512

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 36
error_msg	String	Error message. Minimum: 2 Maximum: 512

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 36
error_msg	String	Error message. Minimum: 2 Maximum: 512

Example Requests

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

Previous topic: Modifying a Scheduling

Next topic: Creating a Composite Task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot