Batch Deleting Migration Tasks
Function
This API is used to delete multiple migration tasks in a batch.
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
POST /v3/tasks/delete
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
ids |
Yes |
Array of strings |
The IDs of the tasks to be deleted. Minimum length: 0 characters Maximum length: 255 characters Array length: 0 to 65,535 |
Response
Status code: 200
OK
None
Example Request
This example deletes tasks whose IDs are 1, 2, and 3 in a batch.
POST https://{endpoint}/v3/tasks/delete
{
"ids" : [ "1", "2", "3" ]
}
Example Response
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
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.
