Help Center/ Server Migration Service/ API Reference/ API/ Task Management/ Managing a Migration Task
Updated on 2025-11-27 GMT+08:00
View PDF

Managing a Migration Task

Function

This API is used to manage migration tasks, including starting tasks, pausing tasks, synchronizing tasks, uploading logs, rolling back failed tasks, 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 length: 1 character

Maximum length: 36

Request

Table 2 Request header parameters

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

skip: skipping the consistency check subtask

clear: clearing snapshot resources

migration_test: starting a migration drill

The value can be:

  • start

  • stop

  • test

  • clone_test

  • restart

  • network_check

  • clear

  • skip

  • migration_test

template_id

No

String

The template ID.

Minimum length: 0 characters

Maximum length: 100 characters

switch_hce

No

Boolean

Indicates whether change to Huawei Cloud EulerOS is enabled.

Default value: false

is_need_consistency_check

No

Boolean

Indicates 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

The encrypted authorization information.

Minimum length: 0 characters

Maximum length: 65,535 characters

error_param

Array of strings

Invalid parameters.

Minimum length: 0 characters

Maximum length: 65,535 characters

Array length: 1 to 20

details

Array of details objects

The error details.

Array length: 1 to 20
Table 6 details

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

  • 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 Response

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

Status Codes

Status Code

Description

200

The management operation for the migration task succeeded.

403

Authentication failed.

Error Codes

For details, see Error Codes.

Parent topic: Task Management