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 unavailable, ready, finished, error, or stopped.
Calling Method
For details, see Calling APIs.
URI
DELETE /v3/tasks/{task_id}
|
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
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
The migration task with a specified ID was deleted. |
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 |
The migration task with a specified ID was deleted. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
