Batch Deleting Migration Tasks

Function

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

Constraints

Migration tasks cannot be deleted if the source server is connected to SMS, and the source server is in one of the following statuses: initialize, stopping, deleting, cloning, replicate, syncing, cutovering, skipping, clearing, premiging.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/delete

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
ids	Yes	Array of strings	The IDs of the tasks to be deleted. Minimum: 0 Maximum: 255 Array Length: 1 - 50

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	String	Deleting migration tasks in batches succeeded.

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 5** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

This example deletes migration tasks with the ID set of 1, 2, and 3 in a batch.

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

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

Example Responses

Status code: 200

Deleting migration tasks in batches succeeded.

{ }

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}