Managing Migration Tasks

Function

This API is used for managing migration tasks, including starting, pausing, and synchronizing tasks, uploading logs, and rolling back failed migration tasks.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/{task_id}/action

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	The migration task ID. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	X-Auth-Token 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
operation	Yes	String	The operation to be performed on the task. start: starting a migration task stop: stopping a migration task test: performing a test clone_test: performing a clone test restart: restarting a migration task network_check: checking network performance The value can be: start stop test clone_test restart network_check
template_id	No	String	The template ID. Minimum length: 0 characters Maximum length: 2,048 characters
switch_hce	No	Boolean	Indicates whether to change to Huawei Cloud EulerOS. Default value: false
is_need_consistency_check	No	Boolean	Whether consistency verification is enabled. Default value: false

Response

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 length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 6** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

Migration tasks can be migrated. To clone the target server in a migration task, a template ID is required. This example clones the target server in the task with 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 whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

{
  "operation" : "start"
}

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

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

{
  "operation" : "stop"
}

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

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

{
  "operation" : "restart"
}

Example Response

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