Deleting a Migration Task

Function

This API is used to delete a migration task with a specified ID.

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

DELETE /v3/tasks/{task_id}

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	The ID of the migration task to be deleted. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum length: 1 character Maximum length: 16,384 characters

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	String	The migration task with a specified ID was deleted successfully.

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 5** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

Delete the migration task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

DELETE https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx

Example Response

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."
  } ]
}