Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Task Management/ Batch Deleting Migration Tasks
Updated on 2022-08-02 GMT+08:00
View PDF
Share

Batch Deleting Migration Tasks

Function

This API is used to delete multiple migration tasks in a batch.

Constraints

You can delete a migration task when the Agent installed on the source server is disconnected from SMS, or the task status is Verification failed, Ready for next, Finished, Error, or Paused.

URI

POST /v3/tasks/delete

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters
Table 2 Request body parameter

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

Specifies the IDs of the tasks to be deleted.

Response

None

Example Request

Delete tasks whose IDs are 1, 2, and 3 in a batch.

POST https://{endpoint}/v3/tasks/delete

{
  "ids" : [ "1", "2", "3" ]
}

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Task Management