Managing Migration Tasks

Function

This API is used to manage migration tasks, including starting, suspending, and synchronizing tasks, uploading logs, and deleting snapshot resources.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/{task_id}/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The migration task ID. Minimum: 1 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
operation	Yes	String	Operation on the task. start stop test cutover: Start the target server. clone_test restart network_check skip: Skip the consistency verification subtask. clear: Clear snapshot resources. migration_test: Start the migration drill. error_for_overspeed: The task is automatically suspended due to overspeed. Enumeration values: start stop test clone_test restart network_check clear skip migration_test
template_id	No	String	The template ID. Minimum: 0 Maximum: 255
switch_hce	No	Boolean	Whether to switch to HCE. Only Linux migration tasks are supported. Default: false
is_need_consistency_check	No	Boolean	Indicates whether consistency verification is enabled. Default: false

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	String	The management operation for the migration task succeeded.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 6** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

Migration tasks can be managed. To clone the target server in a migration task, a template ID is required. This example clones the target server in the task with the ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.
```
POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/action

{
  "operation" : "clone_test",
  "template_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}
```

This example launches the target server in a migration task.

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

{
  "operation" : "test"
}

This example starts the task with the ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

{
  "operation" : "start"
}

This example pauses the task with the ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

{
  "operation" : "stop"
}

This example starts the task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

{
  "operation" : "restart"
}

This example clears snapshot resources for the task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

{
  "operation" : "clear"
}

This example skips the consistency verification subtask.

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

{
  "operation" : "skip"
}

This example starts the migration drill subtask.

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

{
  "operation" : "migration_test"
}

Example Responses

Status code: 200

The management operation for the migration task succeeded.

{ }

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