Help Center/ Server Migration Service/ API Reference/ APIs V3.0/ Task Management/ Managing Migration Tasks
Updated on 2024-09-04 GMT+08:00
View PDF

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

The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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.

The value can be:

  • start

  • stop

  • test

  • clone_test

  • restart

  • network_check

template_id

No

String

The template ID.

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

None

Example Request

  • 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

None

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.

Parent topic: Task Management