/ DOCS
Advanced
Тема интерфейса

Querying Details About a Migration Task

Function

This API is used to query a migration task based on a specified ID.

Calling Method

For details, see Calling APIs.

URI

GET /v3/tasks/{task_id}

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

No

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

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.

The value can be:

  • WINDOWS

  • LINUX

id

String

The migration task ID.

Minimum length: 0 characters

Maximum length: 255 characters

priority

Integer

The migration process priority.

0: low

1: standard (default)

2: high

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

region_id

String

The ID of the region where the target server is located.

Minimum length: 0 characters

Maximum length: 255 characters

start_target_server

Boolean

Specifies whether to start the target server after the migration.

true: indicates that the target server will be launched after the migration.

false: indicates that the target server will be stopped after the migration.

Default value: true

enterprise_project_id

String

The enterprise project ID.

Minimum length: 1 character

Maximum length: 255 characters

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.

Enter the private IP address the target server if the migration network type is Private.

Minimum length: 0 characters

Maximum length: 255 characters

region_name

String

The name of the region where the target server is located.

Minimum length: 0 characters

Maximum length: 255 characters

project_name

String

The name of the project to which the target server belongs.

Minimum length: 0 characters

Maximum length: 255 characters

project_id

String

The ID of the project to which the target server belongs.

Minimum length: 0 characters

Maximum length: 255 characters

vm_template_id

String

The template ID.

Minimum length: 0 characters

Maximum length: 255 characters

source_server

SourceServerResponse object

The source server information returned.

target_server

TaskTargetServer object

The information about the target server in the migration task.

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

connected

Boolean

The connection status.

create_date

Long

The task creation time.

Minimum value: 0

Maximum value: 9223372036854775807

start_date

Long

The task start time.

Minimum value: 0

Maximum value: 9223372036854775807

finish_date

Long

The task end time.

Minimum value: 0

Maximum value: 9223372036854775807

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

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

float_ip

String

Retain this parameter temporarily to ensure the compatibility with the SMS-Agent of the earlier version.

Minimum length: 0 characters

Maximum length: 255 characters

remain_seconds

Long

The remaining migration time in seconds.

Minimum value: 0

Maximum value: 9223372036854775807

target_snapshot_id

String

The ID of the snapshot of the target server.

Minimum length: 0 characters

Maximum length: 255 characters

clone_server

CloneServer object

The information about the cloned server.

sub_tasks

Array of SubTask objects

The list of subtasks contained in the migration task.

Array length: 0 to 65,535 characters

network_check_info

NetworkCheckInfoRequestBody object

The network performance metrics and measurement results.
Table 4 SourceServerResponse 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

Indicates 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

migration_cycle

String

The current migration stage of the source server.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • cutovering

  • cutovered

  • checking

  • setting

  • replicating

  • syncing
Table 5 TaskTargetServer 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. This parameter is not required for automatically created 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 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

system_dir

String

The system directory. This parameter is mandatory for Windows.

Minimum length: 0 characters

Maximum length: 255 characters

disks

Array of TargetDisk objects

The disk information of the target server, which is generally the same as that of the source server.

Array length: 0 to 65,535 characters

volume_groups

Array of VolumeGroups objects

The logical volume information of the target server, which is generally the same as that on the source server.

Array length: 0 to 65,535 characters

btrfs_list

Array of strings

The Btrfs information on the source server. This parameter is mandatory for Linux. If no Btrfs exists on the source server, the value is [].

Minimum length: 0 characters

Maximum length: 255 characters

Array length: 0 to 65,535 characters

image_disk_id

String

The ID of the disk where the agent image resides on the target server.

Minimum length: 0 characters

Maximum length: 255 characters

cutovered_snapshot_ids

String

The ID of the snapshot of the target server, which is used for rollback.

Minimum length: 0 characters

Maximum length: 255 characters
Table 6 TargetDisk field description

Parameter

Type

Description

id

Long

The disk ID.

Minimum value: 0

Maximum value: 9223372036854775807

device_use

String

The partition function.

Default value: NORMAL

The value can be:

  • NORMAL

  • OS

  • BOOT

disk_id

String

The disk ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The disk name.

Minimum length: 0 characters

Maximum length: 255 characters

physical_volumes

Array of TargetPhysicalVolumes objects

The logical volume information.

Array length: 0 to 65,535 characters

size

Long

The size.

Minimum value: 0

Maximum value: 9223372036854775807

used_size

Long

The used space.

Minimum value: 0

Maximum value: 9223372036854775807

disk_index

String

The disk index.

Minimum length: 0 characters

Maximum length: 255 characters

os_disk

Boolean

Indicates whether the disk is the system disk.

partition_style

String

The disk partition type. This parameter is mandatory for source server registration.

The value can be:

  • MBR

  • GPT

relation_name

String

The name of the corresponding disk on the target server running Linux.

Minimum length: 0 characters

Maximum length: 255 characters
Table 7 TargetPhysicalVolumes field description

Parameter

Type

Description

id

Long

The logical volume ID.

Minimum value: 0

Maximum value: 9223372036854775807

device_use

String

The partition function.

Default value: NORMAL

The value can be:

  • NORMAL

  • OS

  • BOOT

file_system

String

The file system.

Minimum length: 0 characters

Maximum length: 255 characters

index

Integer

The volume ID.

Minimum value: 0

Maximum value: 2147483647

mount_point

String

The mount point.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The name.

Minimum length: 0 characters

Maximum length: 255 characters

size

Long

The size.

Minimum value: 0

Maximum value: 9223372036854775807

used_size

Long

The used space.

Minimum value: 0

Maximum value: 9223372036854775807

The UUID.

String

The UUID.

Minimum length: 0 characters

Maximum length: 255 characters

relation_name

String

The name of the corresponding disk on the target server running Linux.

Minimum length: 0 characters

Maximum length: 255 characters

free_size

Long

The idle partition space.

Minimum value: 0

Maximum value: 9223372036854775807
Table 8 VolumeGroups field description

Parameter

Type

Description

components

String

The physical volume information.

Minimum length: 0 characters

Maximum length: 255 characters

free_size

Long

The available space.

Minimum value: 0

Maximum value: 9223372036854775807

logical_volumes

Array of LogicalVolumes objects

The logical volume information.

Array length: 0 to 255 characters

name

String

The name.

Minimum length: 0 characters

Maximum length: 255 characters

size

Long

The size.

Minimum value: 0

Maximum value: 9223372036854775807
Table 9 LogicalVolumes field description

Parameter

Type

Description

block_count

Integer

The number of blocks.

Minimum value: 0

Maximum value: 4294967296

Default value: 0

block_size

Long

The block size.

Minimum value: 0

Maximum value: 1048576

Default value: 0

file_system

String

The file system.

Minimum length: 0 characters

Maximum length: 255 characters

inode_size

Integer

The number of inodes.

Minimum value: 0

Maximum value: 4294967296

device_use

Integer

The used space.

Minimum value: 0

Maximum value: 4294967296

mount_point

String

The mount point.

Minimum length: 0 characters

Maximum length: 256 characters

name

String

The name.

Minimum length: 0 characters

Maximum length: 1,024 characters

size

Long

The size.

Minimum value: 0

Maximum value: 9223372036854775807

used_size

Long

The used space.

Minimum value: 0

Maximum value: 9223372036854775807

free_size

Long

The available space.

Minimum value: 0

Maximum value: 9223372036854775807
Table 10 CloneServer 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

clone_error

String

The error message returned for a clone failure.

Minimum length: 0 characters

Maximum length: 255 characters

clone_state

String

The cloning status.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message returned for a clone failure.

Minimum length: 0 characters

Maximum length: 1,024 characters
Table 11 SubTask 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

migrate_speed

Double

The migration speed in Mbit/s.

Minimum value: 0

Maximum value: 10000

user_op

String

The user operation that triggers the subtask.

Minimum length: 0 characters

Maximum length: 50 characters

process_trace

String

Detailed progress of the migration or synchronization

Minimum length: 0 characters

Maximum length: 2,048 characters
Table 12 NetworkCheckInfoRequestBody field description

Parameter

Type

Description

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

Example Request

Query a migration task with a specified ID.

GET https://{endpoint}/v3/tasks/ef3b9722-07a0-40ae-89b0-889ee96dfc56

Example Response

Status code: 200

OK

{
  "id" : "1dcbf9f2-9f2a-4df8-88dc-27e5614a1187",
  "name" : "MigrationTask",
  "type" : "MIGRATE_BLOCK",
  "os_type" : "WINDOWS",
  "state" : "RUNNING",
  "estimate_complete_time" : null,
  "create_date" : 1598435778000,
  "start_date" : 1598435784000,
  "finish_date" : null,
  "priority" : 1,
  "speed_limit" : 0,
  "migrate_speed" : 0.0,
  "start_target_server" : true,
  "error_json" : "",
  "total_time" : 115,
  "float_ip" : null,
  "migration_ip" : null,
  "vm_template_id" : "38d53ae9-70e3-4587-89c9-6219d3d4e962",
  "region_name" : "region name",
  "region_id" : "region id",
  "project_name" : "project name",
  "project_id" : "b276e6fb38c74aa2ba4598f049745ce9",
  "sub_tasks" : [ {
    "id" : 7278,
    "name" : "CREATE_CLOUD_SERVER",
    "progress" : 0,
    "start_date" : 1598435802000,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7279,
    "name" : "SSL_CONFIG",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7280,
    "name" : "ATTACH_AGENT_IMAGE",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7281,
    "name" : "FORMAT_DISK_WINDOWS",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7282,
    "name" : "MIGRATE_WINDOWS_BLOCK",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  } ],
  "source_server" : {
    "id" : "1cce5dab-df33-4abe-b2ac-e94fa05d6a01",
    "ip" : "192.168.0.154",
    "name" : "name-win16",
    "os_type" : "WINDOWS",
    "os_version" : "WINDOWS2016_64BIT",
    "oem_system" : false,
    "state" : "initialize",
    "migration_cycle" : "replicating"
  },
  "target_server" : {
    "id" : "c1bd67b6-1caa-403e-9e32-81d2feafcda9",
    "vm_id" : "",
    "name" : "",
    "ip" : null,
    "os_type" : "WINDOWS",
    "os_version" : "WINDOWS2016_64BIT",
    "system_dir" : "Y:\\Windows\\System32",
    "disks" : [ {
      "id" : 88008,
      "name" : "Disk 1",
      "relation_name" : null,
      "disk_id" : "0",
      "partition_style" : "MBR",
      "size" : 42949672960,
      "used_size" : 42947575808,
      "device_use" : "OS",
      "os_disk" : true,
      "physical_volumes" : [ {
        "id" : 135055,
        "uuid" : "\\\\?\\Volume{586b7157-0000-0000-0000-100000000000}\\",
        "index" : 1,
        "name" : "Z:",
        "relation_name" : null,
        "device_use" : "BOOT",
        "file_system" : "NTFS",
        "mount_point" : null,
        "size" : 524288000,
        "used_size" : 410275840,
        "free_size" : 114012160
      }, {
        "id" : 135056,
        "uuid" : "\\\\?\\Volume{586b7157-0000-0000-0000-501f00000000}\\",
        "index" : 2,
        "name" : "Y:",
        "relation_name" : null,
        "device_use" : "OS",
        "file_system" : "NTFS",
        "mount_point" : null,
        "size" : 42423287808,
        "used_size" : 23170301952,
        "free_size" : 19252985856
      } ],
      "disk_index" : "\u0000"
    } ],
    "volume_groups" : [ ],
    "image_disk_id" : null,
    "cutovered_snapshot_ids" : null
  },
  "clone_server" : null
}

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.

Parent topic: Task Management
Предыдущая статья
Deleting a Migration Task
Следующая статья
Updating a Migration Task
Была ли эта статья полезна?
Поддержка Юридические документы
© 2025 Cloud.ru