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

Deleting a Migration Task with a Specified ID

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.

URI

DELETE /v3/tasks/{task_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

task_id

Yes

String

Specifies 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

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

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

OK

Error Codes

See Error Codes.

Parent topic: Task Management