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

Listing Migration Tasks

Function

After the target server is configured for a source server, SMS automatically creates a migration task. This API is used to list all your migration tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v3/tasks

Table 1 Query parameters

Parameter

Mandatory

Type

Description

state

No

String

The migration task status.

The value can be:

  • READY

  • RUNNING

  • SYNCING

  • MIGRATE_SUCCESS

  • MIGRATE_FAIL

  • ABORTING

  • ABORT

  • DELETING

  • SYNC_F_ROLLBACKING

  • SYNC_F_ROLLBACK_SUCCESS

name

No

String

The task name.

Minimum length: 0 characters

Maximum length: 255 characters

id

No

String

The task ID.

Minimum length: 0 characters

Maximum length: 255 characters

source_server_id

No

String

The source server ID.

Minimum length: 0 characters

Maximum length: 255 characters

limit

No

Integer

The number of tasks recorded on each page.

Minimum value: 0

Maximum value: 200

Default value: 100

offset

No

Integer

The offset.

Minimum value: 0

Maximum value: 65535

Default value: 0

enterprise_project_id

No

String

The ID of the enterprise project to be queried.

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

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

The number of tasks that meet the search criteria, which is not affected by pagination.

Minimum value: 0

Maximum value: 2147483647

tasks

Array of TasksResponseBody objects

The information about the queried tasks.

Array length: 0 to 65,535 characters
Table 4 TasksResponseBody field description

Parameter

Type

Description

id

String

The migration task ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The task name, which is defined by the user.

Minimum length: 0 characters

Maximum length: 255 characters

type

String

The task type. This parameter is mandatory for creating a task and optional for updating a task.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • MIGRATE_FILE

  • MIGRATE_BLOCK

os_type

String

The OS type. This parameter is mandatory for creating a task and optional for updating a task.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • WINDOWS

  • LINUX

state

String

The task status.

Minimum length: 0 characters

Maximum length: 255 characters

estimate_complete_time

Long

The estimated completion time.

Minimum value: 0

Maximum value: 9223372036854775807

create_date

Long

The task creation time.

Minimum value: 0

Maximum value: 9223372036854775807

priority

Integer

The migration process priority.

Minimum value: 0

Maximum value: 2

The value can be:

  • 0

  • 1

  • 2

speed_limit

Integer

The migration rate limit.

Minimum value: 0

Maximum value: 65535

migrate_speed

Double

The migration rate, in MB/s.

Minimum value: 0

Maximum value: 10000

compress_rate

Double

The compression rate.

Minimum value: 0

Maximum value: 10000

start_target_server

Boolean

Specifies whether to start the target server after the migration is complete. The value can be true (start) or false (stop).

Default value: false

error_json

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

total_time

Long

The task duration.

Minimum value: 0

Maximum value: 9223372036854775807

migration_ip

String

The IP address of the target server. If you use a public network for migration, enter the EIP bound to the target server. If you use a private line for migration, enter a private IP address of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

sub_tasks

Array of SubTaskAssociatedWithTask objects

The information about subtasks associated with the migration task

Array length: 0 to 65,535 characters

source_server

SourceServerAssociatedWithTask object

The information about the source server associated with the migration task.

enterprise_project_id

String

The migration project ID.

Minimum length: 0 characters

Maximum length: 255 characters

target_server

TargetServerAssociatedWithTask object

The information about the target server in the migration task.

log_collect_status

String

The log collection status.

The value can be:

  • INIT

  • TELL_AGENT_TO_COLLECT

  • WAIT_AGENT_COLLECT_ACK

  • AGENT_COLLECT_FAIL

  • AGENT_COLLECT_SUCCESS

  • WAIT_SERVER_COLLECT

  • SERVER_COLLECT_FAIL

  • SERVER_COLLECT_SUCCESS

  • TELL_AGENT_RESET_ACL

  • WAIT_AGENT_RESET_ACL_ACK

clone_server

CloneServerBrief object

The information about the cloned server.

syncing

Boolean

Whether to enable synchronization.

network_check_info

NetworkCheckInfoRequestBody object

The network performance metrics and measurement results.

special_config

Array of ConfigBody objects

The configuration information of advanced migration options.
Table 5 SubTaskAssociatedWithTask field description

Parameter

Type

Description

id

Long

The subtask ID.

Minimum value: 0

Maximum value: 9223372036854775807

name

String

The subtask name.

Minimum length: 0 characters

Maximum length: 255 characters

progress

Integer

The progress of the subtask. The value is an integer ranging from 0 to 100.

Minimum value: 0

Maximum value: 100

start_date

Long

The start time of the subtask.

Minimum value: 0

Maximum value: 9223372036854775807

end_date

Long

The end time of the subtask. If the subtask is not complete, this parameter is left blank.

Minimum value: 0

Maximum value: 9223372036854775807

process_trace

String

Detailed progress of the migration or synchronization

Minimum length: 0 characters

Maximum length: 2,048 characters
Table 6 SourceServerAssociatedWithTask field description

Parameter

Type

Description

id

String

The ID of the source server in the SMS database.

Minimum length: 0 characters

Maximum length: 255 characters

ip

String

The IP address of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The name of the source server displayed on the SMS console.

Minimum length: 0 characters

Maximum length: 255 characters

os_type

String

The OS type of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • WINDOWS

  • LINUX

os_version

String

The OS version. This parameter is mandatory for registration and optional for update.

Minimum length: 0 characters

Maximum length: 255 characters

oem_system

Boolean

Specifies whether the OS is an OEM OS (Windows).

state

String

The source server status.

The value can be:

  • unavailable

  • waiting

  • initialize

  • replicate

  • syncing

  • stopping

  • stopped

  • deleting

  • error

  • cloning

  • testing

  • finished
Table 7 TargetServerAssociatedWithTask field description

Parameter

Type

Description

id

String

The ID of the target server in the SMS database.

Minimum length: 0 characters

Maximum length: 255 characters

vm_id

String

The ID of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The name of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

ip

String

The IP address of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

os_type

String

The OS type of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • WINDOWS

  • LINUX

os_version

String

The OS version.

Minimum length: 0 characters

Maximum length: 255 characters
Table 8 CloneServerBrief field description

Parameter

Type

Description

vm_id

String

The cloned server ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The name of the cloned server.

Minimum length: 0 characters

Maximum length: 255 characters
Table 9 NetworkCheckInfoRequestBody field description

Parameter

Type

Description

domain_connectivity

Boolean

The connectivity to domain names.

destination_connectivity

Boolean

The connectivity to the target server.

network_delay

Double

The network latency.

Minimum value: 0

Maximum value: 10000.0

network_jitter

Double

The network jitter.

Minimum value: 0

Maximum value: 10000

migration_speed

Double

The bandwidth.

Minimum value: 0

Maximum value: 10000

loss_percentage

Double

The packet loss rate.

Minimum value: 0

Maximum value: 100

cpu_usage

Double

The CPU usage.

Minimum value: 0

Maximum value: 100

mem_usage

Double

The memory usage.

Minimum value: 0

Maximum value: 100

evaluation_result

String

The network evaluation result.

Minimum length: 6 characters

Maximum length: 8 characters
Table 10 ConfigBody field description

Parameter

Type

Description

config_key

String

The advanced migration option. The value can be EXCLUDE_MIGRATE_PATH, SYNC_EXCLUDE_PATH, or ONLY_SYNC_PATH.

Minimum length: 0 characters

Maximum length: 255 characters

config_value

String

The value specified for the advanced migration option. It is stored in the database and parsed on the Agent.

Minimum length: 0 characters

Maximum length: 1,024 characters

config_status

String

The reserved field that describes the configuration status.

Minimum length: 0 characters

Maximum length: 255 characters

Example Request

This example lists all migration tasks.

GET https://{endpoint}/v3/tasks

Example Response

Status code: 200

The list of migration tasks is returned.

{
  "count" : 3,
  "tasks" : [ {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_lxxxx11",
    "type" : "MIGRATE_FILE",
    "os_type" : "LINUX",
    "state" : "MIGRATE_SUCCESS",
    "estimate_complete_time" : null,
    "create_date" : 1585139506000,
    "priority" : 1,
    "speed_limit" : 0,
    "migrate_speed" : 0.0,
    "start_target_server" : true,
    "error_json" : "",
    "total_time" : 3878000,
    "migration_ip" : "",
    "source_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "ip" : "192.168.*.107",
      "name" : "xxx-linux-1",
      "os_type" : "LINUX",
      "os_version" : "CENTOS_7_6_64BIT",
      "oem_system" : false,
      "state" : "AVAILABLE"
    },
    "target_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "",
      "name" : "",
      "ip" : null,
      "os_type" : "LINUX",
      "os_version" : null
    },
    "log_collect_status" : "INIT"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_xxx22",
    "type" : "MIGRATE_BLOCK",
    "os_type" : "WINDOWS",
    "state" : "MIGRATE_SUCCESS",
    "estimate_complete_time" : null,
    "create_date" : 1585138569000,
    "priority" : 1,
    "speed_limit" : 0,
    "migrate_speed" : 0.0,
    "start_target_server" : true,
    "error_json" : "",
    "total_time" : 10824000,
    "migration_ip" : "",
    "source_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "ip" : "192.168.*.245",
      "name" : "xxx-windows-2",
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2012_R2_64BIT",
      "oem_system" : false,
      "state" : "AVAILABLE"
    },
    "target_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "",
      "name" : "",
      "ip" : null,
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2012_R2_64BIT"
    },
    "log_collect_status" : "INIT"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_leddesktop",
    "type" : "MIGRATE_BLOCK",
    "os_type" : "WINDOWS",
    "state" : "MIGRATE_SUCCESS",
    "estimate_complete_time" : null,
    "create_date" : 1566130392000,
    "priority" : 1,
    "speed_limit" : 200,
    "migrate_speed" : 0.0,
    "start_target_server" : true,
    "error_json" : "",
    "total_time" : 882000,
    "migration_ip" : "192.168.1.201",
    "source_server" : null,
    "target_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "name" : "xxx-sms-target",
      "ip" : null,
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2008_R2_64BIT"
    },
    "log_collect_status" : "INIT"
  } ]
}

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.

Parent topic: Task Management