Deleting a Batch Task

Updated on 2024-04-22 GMT+08:00

View PDF

This API is used to delete a batch task.

DELETE /v2/{project_id}/batch-tasks/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.
id	Yes	String	Batch task ID

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. For details about how to obtain a user token, see Authentication.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of tasks
failed_count	Integer	Number of failed tasks
succeed_count	Integer	Number of successfully executed tasks
id	String	Batch task ID
error_list	Array of strings	Error information list

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description
detail	String	Error details
params	Array of strings	Error parameters Array Length: 0 - 1
reason	String	Error cause
advice	String	Suggestion

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description
detail	String	Error details
params	Array of strings	Error parameters Array Length: 0 - 1
reason	String	Error cause
advice	String	Suggestion

This request is used to delete the batch task whose ID is {id}.

https://xxxxt/v2/xxx/batch-tasks/xxx?

Status code: 200

Response to a batch operation request

{
  "total_count" : 2,
  "failed_count" : 0,
  "succeed_count" : 2,
  "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "error_list" : [ ]
}

Status Code	Description
200	Response to a batch operation request
400	Request error
500	Internal error

Parent topic: Task Center

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.