Updating a Migration Task
Function
This API is used to update a migration task by ID.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/tasks/{task_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
Yes |
String |
The migration task ID. Minimum length: 0 characters Maximum length: 255 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
The task name, which is defined by the user. Minimum length: 0 characters Maximum length: 255 characters |
|
type |
No |
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:
|
|
os_type |
No |
String |
The OS type. This parameter is mandatory for creating a task and optional for updating a task. The value can be:
|
|
id |
No |
String |
The migration task ID. Minimum length: 0 characters Maximum length: 255 characters |
|
priority |
No |
Integer |
The migration process priority. 0: low 1: standard (default) 2: high Minimum value: 0 Maximum value: 2 The value can be:
|
|
region_id |
No |
String |
The ID of the region where the target server is located. Minimum length: 0 characters Maximum length: 255 characters |
|
start_target_server |
No |
Boolean |
Indicates whether to start the target server after the migration is complete. true: indicates that the target server will be launched after the migration is complete. false: indicates that the target server will be stopped after the migration is complete. Default value: true |
|
enterprise_project_id |
No |
String |
The enterprise project ID. Minimum length: 1 character Maximum length: 255 characters |
|
exist_server |
No |
Boolean |
Whether to use an existing server as the target server. true indicates that an existing server is used as the target server. false indicates that the target server is newly created. |
|
migration_ip |
No |
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 the private IP address of the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
region_name |
No |
String |
The name of the region where the target server is located. Minimum length: 0 characters Maximum length: 255 characters |
|
speed_limit |
No |
Integer |
The migration rate limit, in Mbit/s. Minimum value: 0 Maximum value: 10000 |
|
project_name |
No |
String |
The name of the project to which the target server belongs. Minimum length: 0 characters Maximum length: 255 characters |
|
project_id |
No |
String |
The ID of the project to which the target server belongs. Minimum length: 0 characters Maximum length: 255 characters |
|
vm_template_id |
No |
String |
The template ID. Minimum length: 0 characters Maximum length: 255 characters |
|
source_server |
No |
PostSourceServerBody object |
The information about the source server in the migration task. |
|
target_server |
No |
TargetServer object |
The information about the target server in the migration task. |
|
state |
No |
String |
The task status. Minimum length: 0 characters Maximum length: 255 characters |
|
estimate_complete_time |
No |
Long |
The estimated completion time. Minimum value: 0 Maximum value: 9223372036854775807 |
|
connected |
No |
Boolean |
The connection status. |
|
create_date |
No |
Long |
The task creation time. Minimum value: 0 Maximum value: 9223372036854775807 |
|
start_date |
No |
Long |
The task start time. Minimum value: 0 Maximum value: 9223372036854775807 |
|
finish_date |
No |
Long |
The task end time. Minimum value: 0 Maximum value: 9223372036854775807 |
|
migrate_speed |
No |
Double |
The migration rate, in MB/s. Minimum value: 0 Maximum value: 10000 |
|
error_json |
No |
String |
The error message. Minimum length: 0 characters Maximum length: 1,024 characters |
|
total_time |
No |
Long |
The migration time elapsed. Minimum value: 0 Maximum value: 9223372036854775807 |
|
float_ip |
No |
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 |
No |
Long |
The remaining migration time, in seconds. Minimum value: 0 Maximum value: 9223372036854775807 |
|
target_snapshot_id |
No |
String |
The ID of the snapshot for the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
clone_server |
No |
CloneServer object |
The information about the cloned server. |
|
sub_tasks |
No |
Array of SubTask objects |
The list of subtasks included in the migration task. Array length: 0 to 65,535 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
The ID of the target server in the SMS database. Minimum length: 0 characters Maximum length: 255 characters |
|
ip |
No |
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 |
No |
String |
The name of the source server displayed on the SMS console. Minimum length: 0 characters Maximum length: 255 characters |
|
hostname |
No |
String |
The hostname 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 |
|
os_type |
No |
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:
|
|
os_version |
No |
String |
The OS version. This parameter is mandatory for registration and optional for update. Minimum length: 0 characters Maximum length: 255 characters |
|
virtualization_type |
No |
String |
The OS virtualization type. Minimum length: 0 characters Maximum length: 255 characters |
|
linux_block_check |
No |
String |
The Linux block-level check. Minimum length: 0 characters Maximum length: 255 characters |
|
firmware |
No |
String |
The boot mode of the source server. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
|
cpu_quantity |
No |
Integer |
The number of vCPUs. Minimum value: 0 Maximum value: 65535 |
|
memory |
No |
Long |
The memory size, in MB. Minimum value: 0 Maximum value: 9223372036854775807 |
|
disks |
No |
Array of ServerDisk objects |
The disk information of the source server. Array length: 0 to 65,535 characters |
|
btrfs_list |
No |
Array of BtrfsFileSystem objects |
The information about Btrfs file systems on the source server. This parameter is mandatory for Linux. If there are no Btrfs file systems on the source server, the value is an empty array []. Array length: 0 to 65,535 characters |
|
networks |
No |
Array of NetWork objects |
The information about NICs on the source server. Array length: 0 to 65,535 characters |
|
domain_id |
No |
String |
The tenant domain ID. Minimum length: 0 characters Maximum length: 255 characters |
|
has_rsync |
No |
Boolean |
Indicates whether rsync is installed. This parameter is mandatory for Linux. |
|
paravirtualization |
No |
Boolean |
Indicates whether the source server is paravirtualized. This parameter is mandatory for Linux. |
|
raw_devices |
No |
String |
The list of raw devices. This parameter is mandatory for Linux. Minimum length: 0 characters Maximum length: 255 characters |
|
driver_files |
No |
Boolean |
Indicates whether any driver files are missing. This parameter is mandatory for Windows. |
|
system_services |
No |
Boolean |
Indicates whether there are abnormal services. This parameter is mandatory for Windows. |
|
account_rights |
No |
Boolean |
Indicates whether the account has the required permissions. This parameter is mandatory for Windows. |
|
boot_loader |
No |
String |
The system boot loader. This parameter is mandatory for Linux. The value can be:
|
|
system_dir |
No |
String |
The system directory. This parameter is mandatory for Windows. Minimum length: 0 characters Maximum length: 255 characters |
|
volume_groups |
No |
Array of VolumeGroups objects |
This parameter is mandatory for Linux. If there are no volume groups, the value is an empty array []. Array length: 0 to 65,535 characters |
|
agent_version |
No |
String |
The Agent version. Minimum length: 0 characters Maximum length: 255 characters |
|
kernel_version |
No |
String |
The kernel version. Minimum length: 0 characters Maximum length: 255 characters |
|
migration_cycle |
No |
String |
The current migration stage of the source server. The value can be:
|
|
state |
No |
String |
The source server status. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
|
oem_system |
No |
Boolean |
Indicates whether the OS is an OEM version (Windows). |
|
start_type |
No |
String |
The startup mode. The value can be MANUAL, MGC, or an empty string (""). The value can be:
|
|
io_read_wait |
No |
Double |
The disk read latency (in ms). Minimum value: 0.0 Maximum value: 10000.0 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
The disk name. Minimum length: 0 characters Maximum length: 255 characters |
|
partition_style |
No |
String |
The disk partition type. This parameter is mandatory for source server registration. The value can be:
|
|
device_use |
Yes |
String |
The disk function. The value can be:
|
|
size |
Yes |
Long |
The disk size, in bytes. Minimum value: 0 Maximum value: 9223372036854775807 |
|
used_size |
Yes |
Long |
The used disk space, in bytes. Minimum value: 0 Maximum value: 9223372036854775807 |
|
physical_volumes |
Yes |
Array of PhysicalVolume objects |
The physical partition information of the disk. Array length: 0 to 65,535 characters |
|
os_disk |
No |
Boolean |
Indicates whether the disk is the system disk. |
|
relation_name |
No |
String |
The name of the paired target server disk in Linux. Minimum length: 0 characters Maximum length: 255 characters |
|
inode_size |
No |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 2147483647 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
device_use |
No |
String |
The partition type. The value can be NORMAL, BOOT, or OS. Minimum length: 0 characters Maximum length: 255 characters |
|
file_system |
No |
String |
The file system type. Minimum length: 0 characters Maximum length: 255 characters |
|
index |
No |
Integer |
The serial number of the volume. Minimum value: 0 Maximum value: 2147483647 |
|
mount_point |
No |
String |
The mount point. Minimum length: 0 characters Maximum length: 255 characters |
|
name |
No |
String |
The volume name. In Windows, it indicates the drive letter, and in Linux, it indicates the device ID. Minimum length: 0 characters Maximum length: 255 characters |
|
size |
No |
Long |
The size. Minimum value: 0 Maximum value: 9223372036854775807 |
|
used_size |
No |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
inode_size |
No |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 2147483647 |
|
inode_nums |
No |
Long |
The number of inodes. Minimum value: 0 Maximum value: 9223372036854775807 |
|
uuid |
No |
String |
The GUID of the volume, which can be obtained from the source server. Minimum length: 0 characters Maximum length: 255 characters |
|
size_per_cluster |
No |
Integer |
The size of each cluster. Minimum value: 0 Maximum value: 2147483647 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
The ID of the target server in the SMS database. Minimum length: 0 characters Maximum length: 255 characters |
|
ip |
Yes |
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 |
No |
String |
The name of the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
hostname |
No |
String |
The hostname 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 |
|
os_type |
Yes |
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:
|
|
os_version |
No |
String |
The OS version. This parameter is mandatory for registration and optional for update. Minimum length: 0 characters Maximum length: 255 characters |
|
firmware |
No |
String |
The boot mode of the source server. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
|
cpu_quantity |
No |
Integer |
The number of vCPUs. Minimum value: 0 Maximum value: 65535 |
|
memory |
No |
Long |
The memory size, in MB. Minimum value: 0 Maximum value: 9223372036854775807 |
|
disks |
Yes |
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 |
|
btrfs_list |
No |
Array of BtrfsFileSystem objects |
The information about Btrfs file systems on the source server. This parameter is mandatory for Linux. If there are no Btrfs file systems on the source server, the value is an empty array []. Array length: 0 to 65,535 characters |
|
networks |
No |
Array of NetWork objects |
The information about NICs on the source server. Array length: 0 to 65,535 characters |
|
domain_id |
No |
String |
The tenant domain ID. Minimum length: 0 characters Maximum length: 255 characters |
|
has_rsync |
No |
Boolean |
Indicates whether rsync is installed. This parameter is mandatory for Linux. |
|
paravirtualization |
No |
Boolean |
Indicates whether the source server is paravirtualized. This parameter is mandatory for Linux. |
|
raw_devices |
No |
String |
The list of raw devices. This parameter is mandatory for Linux. Minimum length: 0 characters Maximum length: 255 characters |
|
driver_files |
No |
Boolean |
Indicates whether any driver files are missing. This parameter is mandatory for Windows. |
|
system_services |
No |
Boolean |
Indicates whether there are abnormal services. This parameter is mandatory for Windows. |
|
account_rights |
No |
Boolean |
Indicates whether the account has the required permissions. This parameter is mandatory for Windows. |
|
boot_loader |
No |
String |
The system boot loader. This parameter is mandatory for Linux. The value can be:
|
|
system_dir |
No |
String |
The system directory. This parameter is mandatory for Windows. Minimum length: 0 characters Maximum length: 255 characters |
|
volume_groups |
No |
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 |
|
vm_id |
No |
String |
The ID of the target server. This parameter is not required for automatically created target servers. Minimum length: 0 characters Maximum length: 255 characters |
|
flavor |
No |
String |
The flavor of the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
image_disk_id |
No |
String |
The ID of the disk where the agent image is contained on the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
snapshot_ids |
No |
String |
The ID of the snapshot for the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
cutovered_snapshot_ids |
No |
String |
The ID of the snapshot used for rollback on the target server. Minimum length: 0 characters Maximum length: 255 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
Long |
The disk ID. Minimum value: 0 Maximum value: 9223372036854775807 |
|
device_use |
No |
String |
The partition function. Default value: NORMAL The value can be:
|
|
disk_id |
No |
String |
The disk ID. Minimum length: 0 characters Maximum length: 255 characters |
|
name |
No |
String |
The disk name. Minimum length: 0 characters Maximum length: 255 characters |
|
physical_volumes |
No |
Array of TargetPhysicalVolumes objects |
The logical volume information. Array length: 0 to 65,535 characters |
|
size |
No |
Long |
The size. Minimum value: 0 Maximum value: 9223372036854775807 |
|
used_size |
No |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
disk_index |
No |
String |
The disk index. Minimum length: 0 characters Maximum length: 255 characters |
|
os_disk |
No |
Boolean |
Indicates whether the disk is the system disk. |
|
partition_style |
No |
String |
The disk partition type. This parameter is mandatory for source server registration. The value can be:
|
|
relation_name |
No |
String |
The name of the paired target server disk in Linux. Minimum length: 0 characters Maximum length: 255 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
Long |
The logical volume ID. Minimum value: 0 Maximum value: 9223372036854775807 |
|
device_use |
No |
String |
The partition function. Default value: NORMAL The value can be:
|
|
file_system |
No |
String |
The file system. Minimum length: 0 characters Maximum length: 255 characters |
|
index |
No |
Integer |
The serial number. Minimum value: 0 Maximum value: 2147483647 |
|
mount_point |
No |
String |
The mount point. Minimum length: 0 characters Maximum length: 255 characters |
|
name |
No |
String |
The name. Minimum length: 0 characters Maximum length: 255 characters |
|
size |
No |
Long |
The size. Minimum value: 0 Maximum value: 9223372036854775807 |
|
used_size |
No |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
uuid |
No |
String |
uuid Minimum length: 0 characters Maximum length: 255 characters |
|
relation_name |
No |
String |
The name of the paired target server disk in Linux. Minimum length: 0 characters Maximum length: 255 characters |
|
free_size |
No |
Long |
The idle partition space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
The file system name. Minimum length: 0 characters Maximum length: 255 characters |
|
label |
Yes |
String |
The file system tag. If no tag exists, the value is an empty string. Minimum length: 0 characters Maximum length: 255 characters |
|
uuid |
Yes |
String |
The UUID of the file system. Minimum length: 0 characters Maximum length: 255 characters |
|
device |
Yes |
String |
The names of Btrfs devices. Minimum length: 0 characters Maximum length: 255 characters |
|
size |
Yes |
Long |
The space occupied by the file system. Minimum value: 0 Maximum value: 9223372036854775807 |
|
nodesize |
Yes |
Long |
The size of the Btrfs node. Minimum value: 0 Maximum value: 9223372036854775807 |
|
sectorsize |
Yes |
Integer |
The sector size. Minimum value: 0 Maximum value: 2147483647 |
|
data_profile |
Yes |
String |
The data profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
|
system_profile |
Yes |
String |
The file system profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
|
metadata_profile |
Yes |
String |
The metadata profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
|
global_reserve1 |
Yes |
String |
The Btrfs file system information. Minimum length: 0 characters Maximum length: 255 characters |
|
g_vol_used_size |
Yes |
Long |
The used space of the Btrfs volume. Minimum value: 0 Maximum value: 9223372036854775807 |
|
default_subvolid |
Yes |
String |
The ID of the default subvolume. Minimum length: 0 characters Maximum length: 255 characters |
|
default_subvol_name |
Yes |
String |
The name of the default subvolume. Minimum length: 0 characters Maximum length: 255 characters |
|
default_subvol_mountpath |
Yes |
String |
The mount path of the default subvolume or Btrfs file system. Minimum length: 0 characters Maximum length: 255 characters |
|
subvolumn |
Yes |
Array of BtrfsSubvolumn objects |
The subvolume information. Array length: 0 to 65,535 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
uuid |
Yes |
String |
The UUID of the parent volume. Minimum length: 0 characters Maximum length: 255 characters |
|
is_snapshot |
Yes |
String |
Indicates whether the subvolume is a snapshot. Minimum length: 0 characters Maximum length: 255 characters |
|
subvol_id |
Yes |
String |
The subvolume ID. Minimum length: 0 characters Maximum length: 255 characters |
|
parent_id |
Yes |
String |
The parent volume ID. Minimum length: 0 characters Maximum length: 255 characters |
|
subvol_name |
Yes |
String |
The subvolume name. Minimum length: 0 characters Maximum length: 255 characters |
|
subvol_mount_path |
Yes |
String |
The mount path of the subvolume. Minimum length: 0 characters Maximum length: 255 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
The NIC name. Minimum length: 0 characters Maximum length: 255 characters |
|
ip |
Yes |
String |
The IP address bound to the NIC. Minimum length: 0 characters Maximum length: 255 characters |
|
netmask |
Yes |
String |
The subnet mask. Minimum length: 0 characters Maximum length: 255 characters |
|
gateway |
Yes |
String |
The gateway. Minimum length: 0 characters Maximum length: 255 characters |
|
mtu |
No |
Integer |
The NIC MTU. This parameter is mandatory for Linux. Minimum value: 0 Maximum value: 2147483647 |
|
mac |
Yes |
String |
The MAC address. Minimum length: 0 characters Maximum length: 255 characters |
|
id |
No |
String |
The database ID. Minimum length: 0 characters Maximum length: 255 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
components |
No |
String |
The physical volume information. Minimum length: 0 characters Maximum length: 255 characters |
|
free_size |
No |
Long |
The available space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
logical_volumes |
No |
Array of LogicalVolumes objects |
The logical volume information. Array length: 0 to 255 characters |
|
name |
No |
String |
The name. Minimum length: 0 characters Maximum length: 255 characters |
|
size |
No |
Long |
The size. Minimum value: 0 Maximum value: 9223372036854775807 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
block_count |
No |
Integer |
The number of blocks. Minimum value: 0 Maximum value: 2147483647 Default value: 0 |
|
block_size |
No |
Long |
The block size. Minimum value: 0 Maximum value: 1048576 Default: 0 |
|
file_system |
Yes |
String |
The file system. Minimum length: 0 characters Maximum length: 255 characters |
|
inode_size |
Yes |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 2147483647 |
|
inode_nums |
No |
Long |
The number of inodes. Minimum value: 0 Maximum value: 9223372036854775807 |
|
device_use |
No |
String |
The partition type. The value can be NORMAL, BOOT, or OS. Minimum length: 0 characters Maximum length: 255 characters |
|
mount_point |
Yes |
String |
The mount point. Minimum length: 0 characters Maximum length: 256 characters |
|
name |
Yes |
String |
The name. Minimum length: 0 characters Maximum length: 1,024 characters |
|
size |
Yes |
Long |
The size. Minimum value: 0 Maximum value: 9223372036854775807 |
|
used_size |
Yes |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
free_size |
Yes |
Long |
The available space. Minimum value: 0 Maximum value: 9223372036854775807 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
vm_id |
No |
String |
The cloned server ID. Minimum length: 0 characters Maximum length: 255 characters |
|
name |
No |
String |
The name of the cloned server. Minimum length: 0 characters Maximum length: 255 characters |
|
clone_error |
No |
String |
The error code returned for a clone failure. Minimum length: 0 characters Maximum length: 255 characters |
|
clone_state |
No |
String |
The clone status. Minimum length: 0 characters Maximum length: 255 characters |
|
error_msg |
No |
String |
The error message returned for a clone failure. Minimum length: 0 characters Maximum length: 1,024 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
Long |
The subtask ID. Minimum value: 0 Maximum value: 9223372036854775807 |
|
name |
No |
String |
The subtask name. Minimum length: 0 characters Maximum length: 255 characters |
|
progress |
Yes |
Integer |
The progress of the subtask. The value is an integer ranging from 0 to 100. Minimum value: 0 Maximum value: 100 |
|
start_date |
No |
Long |
The start time of the subtask. Minimum value: 0 Maximum value: 9223372036854775807 |
|
end_date |
No |
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 |
No |
Double |
The migration speed, in Mbit/s. Minimum value: 0 Maximum value: 10000 |
|
user_op |
No |
String |
The user operation that triggers the subtask. Minimum length: 0 characters Maximum length: 50 characters |
|
process_trace |
No |
String |
The detailed progress of the migration or synchronization. Minimum length: 0 characters Maximum length: 2,048 characters |
Response
None
Example Request
This example updates the migration task whose ID is ef3b9722-07a0-40ae-89b0-889ee96dxxxx.
put https://{endpoint}/v3/tasks/ef3b9722-07a0-40ae-89b0-889ee96dxxxx
{
"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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"region_name" : "region name",
"region_id" : "region id",
"project_name" : "project name",
"project_id" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"sub_tasks" : [ {
"id" : 7278,
"name" : "CREATE_CLOUD_SERVER",
"progress" : 0,
"start_date" : 1598435802000,
"end_date" : null,
"user_op" : "REPLICATE"
}, {
"id" : 7279,
"name" : "SSL_CONFIG",
"progress" : 0,
"start_date" : null,
"end_date" : null,
"user_op" : "REPLICATE"
}, {
"id" : 7280,
"name" : "ATTACH_AGENT_IMAGE",
"progress" : 0,
"start_date" : null,
"end_date" : null,
"user_op" : "REPLICATE"
}, {
"id" : 7281,
"name" : "FORMAT_DISK_WINDOWS",
"progress" : 0,
"start_date" : null,
"end_date" : null,
"user_op" : "REPLICATE"
}, {
"id" : 7282,
"name" : "MIGRATE_WINDOWS_BLOCK",
"progress" : 0,
"start_date" : null,
"end_date" : null,
"user_op" : "REPLICATE"
} ],
"source_server" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"ip" : "192.168.0.154",
"name" : "name-win16",
"os_type" : "WINDOWS",
"os_version" : "WINDOWS2016_64BIT",
"agent_version" : "1.2.0",
"oem_system" : false,
"state" : "initialize",
"migration_cycle" : "replicating"
},
"target_server" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"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" : "0"
} ],
"volume_groups" : [ ],
"image_disk_id" : null,
"cutovered_snapshot_ids" : null
},
"clone_server" : null
}
Example Response
Status code: 200
OK
{
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
