Updated on 2025-09-16 GMT+08:00

Managing Migration Tasks

Function

This API is used to manage 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

collect_log: collecting logs

test: performing a test

clone_test: performing a clone test

restart: restarting a migration task

sync_failed_rollback: rolling back a migration task that fails to be synchronized

The value can be:

  • start

  • stop

  • collect_log

  • test

  • clone_test

  • restart

  • sync_failed_rollback

param

No

Map<String,String>

The operation parameters.

switch_hce

No

Boolean

Indicates whether changing to Huawei Cloud EulerOS is enabled.

Default value: false

Response

Status code: 200

OK

None

Example Request

  • 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-855fbe12e83b/action
    
    {
      "operation" : "clone_test"
    }
  • This example launches 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" : "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 rolls back the failed synchronization step in the task with ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

    POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/action
    
    {
      "operation" : "sync_failed_rollback"
    }
  • 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 finished task with ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

    POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/action
    
    {
      "operation" : "restart"
    }
  • This example uploads logs for the task with ID 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

For details, see Error Codes.