Updated on 2024-07-08 GMT+08:00

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.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/delete

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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 parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

The IDs of the tasks to be deleted.

Minimum length: 0 characters

Maximum length: 255 characters

Array length: 0 to 65,535 characters

Response

None

Example Request

This example deletes migration tasks with IDs 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

Response returned.

Error Codes

For details, see Error Codes.