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

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. 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

Response

None

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

None

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.