Updating Disk Information
Function
This API is used to overwrite the original disk information of a server with the new disk information.
This API takes effect only when the source server is in the waiting state. After the migration starts, the modification on the disk information does not take effect.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/sources/{source_id}/diskinfo
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source_id |
Yes |
String |
The source server ID. Minimum: 1 Maximum: 36 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
disks |
No |
Array of ServerDisk objects |
The updated disk information. Array Length: 0 - 50 |
|
volumegroups |
No |
Array of VolumeGroups objects |
The updated volume information. Array Length: 0 - 50 |
|
btrfs_list |
No |
Array of BtrfsFileSystem objects |
The updated Btrfs file system information. Array Length: 0 - 65535 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
The disk name. Minimum: 0 Maximum: 255 |
|
partition_style |
No |
String |
Disk partition type. This parameter is mandatory when the source server is added. Otherwise, the subsequent environment check will fail. Options (required by EVS): MBR: Master Boot Record GPT: GUID Partition Table** Partition Table For details, see the description of differences between MBR and GPT in the EVS API document. Minimum: 0 Maximum: 255 |
|
device_use |
No |
String |
Disk type. This is not mandatory and can be left blank. The common values are as follows: NORMAL OS: system device BOOT VOLUME_GROUP BTRFS Minimum: 0 Maximum: 255 |
|
size |
No |
Long |
The disk size, in bytes. Minimum: 0 Maximum: 9223372036854775807 |
|
used_size |
No |
Long |
The used disk space, in bytes. Minimum: 0 Maximum: 9223372036854775807 |
|
physical_volumes |
No |
Array of PhysicalVolume objects |
The information about physical partitions on the disk. Array Length: 0 - 50 |
|
os_disk |
No |
Boolean |
Indicates whether the disk is the system disk. |
|
relation_name |
No |
String |
The name of the paired disk on the Linux target ECS server. Minimum: 0 Maximum: 255 |
|
inode_size |
No |
Integer |
The inode size. Minimum: 0 Maximum: 2147483647 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
device_use |
No |
String |
Disk type. This is not mandatory and can be left blank. The common values are as follows: NORMAL OS: system device BOOT VOLUME_GROUP BTRFS Minimum: 0 Maximum: 255 |
|
file_system |
No |
String |
The file system type. Minimum: 0 Maximum: 255 |
|
index |
No |
Integer |
The serial number. Minimum: 0 Maximum: 2147483647 |
|
mount_point |
No |
String |
The mount point. Minimum: 0 Maximum: 255 |
|
name |
No |
String |
The volume name. In Windows, it indicates the drive letter, and in Linux, it indicates the device ID. Minimum: 0 Maximum: 255 |
|
size |
No |
Long |
The size. Minimum: 0 Maximum: 9223372036854775807 |
|
used_size |
No |
Long |
The used space. Minimum: 0 Maximum: 9223372036854775807 |
|
inode_size |
No |
Integer |
The number of inodes. Minimum: 0 Maximum: 2147483647 |
|
inode_nums |
No |
Long |
The number of inodes. Minimum: 0 Maximum: 9223372036854775807 |
|
uuid |
No |
String |
The GUID, which can be obtained from the source server. Minimum: 0 Maximum: 255 |
|
size_per_cluster |
No |
Integer |
The size of each cluster. Minimum: 0 Maximum: 2147483647 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
components |
No |
String |
The physical volume information. Minimum: 0 Maximum: 255 |
|
free_size |
No |
Long |
The available space. Minimum: 0 Maximum: 9223372036854775807 |
|
logical_volumes |
No |
Array of LogicalVolumes objects |
The logical volume information. Array Length: 0 - 50 |
|
name |
No |
String |
Name. Minimum: 0 Maximum: 255 |
|
size |
No |
Long |
Size. Minimum: 0 Maximum: 9223372036854775807 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
block_count |
No |
Integer |
The number of blocks. Minimum: 0 Maximum: 2147483647 Default: 0 |
|
block_size |
No |
Long |
Block size. Minimum: 0 Maximum: 1048576 Default: 0 |
|
file_system |
No |
String |
The file system. Minimum: 0 Maximum: 255 |
|
inode_size |
No |
Integer |
The number of inodes. Minimum: 0 Maximum: 2147483647 |
|
inode_nums |
No |
Long |
The number of inodes. Minimum: 0 Maximum: 9223372036854775807 |
|
device_use |
No |
String |
Partition type. This is not mandatory and can be left blank. The common values are as follows: NORMAL OS: system device BOOT VOLUME_GROUP BTRFS Minimum: 0 Maximum: 255 |
|
mount_point |
No |
String |
The mount point. Minimum: 0 Maximum: 256 |
|
name |
No |
String |
Name. Minimum: 0 Maximum: 1024 |
|
size |
No |
Long |
The size. Minimum: 0 Maximum: 9223372036854775807 |
|
used_size |
No |
Long |
The used space. Minimum: 0 Maximum: 9223372036854775807 |
|
free_size |
No |
Long |
The available space. Minimum: 0 Maximum: 9223372036854775807 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
The file system name. Minimum: 0 Maximum: 255 |
|
label |
No |
String |
The file system tags. If no tag exists, the value is an empty string. Minimum: 0 Maximum: 255 |
|
uuid |
No |
String |
The file system UUID. Minimum: 0 Maximum: 255 |
|
device |
No |
String |
The device names of the Btrfs file system. Minimum: 0 Maximum: 255 |
|
size |
No |
Long |
The space occupied by the file system data. Minimum: 0 Maximum: 9223372036854775807 |
|
nodesize |
No |
Long |
The Btrfs node size. Minimum: 0 Maximum: 9223372036854775807 |
|
sectorsize |
No |
Integer |
The sector size. Minimum: 0 Maximum: 2147483647 |
|
data_profile |
No |
String |
The data profile (RAD). Minimum: 0 Maximum: 255 |
|
system_profile |
No |
String |
The file system profile (RAD). Minimum: 0 Maximum: 255 |
|
metadata_profile |
No |
String |
The metadata profile (RAD). Minimum: 0 Maximum: 255 |
|
global_reserve1 |
No |
String |
The Btrfs file system information. Minimum: 0 Maximum: 255 |
|
g_vol_used_size |
No |
Long |
The used space of the Btrfs volume. Minimum: 0 Maximum: 9223372036854775807 |
|
default_subvolid |
No |
String |
The ID of the default subvolume. Minimum: 0 Maximum: 255 |
|
default_subvol_name |
No |
String |
The name of the default subvolume. Minimum: 0 Maximum: 255 |
|
default_subvol_mountpath |
No |
String |
The mount path of the default subvolume or Btrfs file system. Minimum: 0 Maximum: 255 |
|
subvolumn |
No |
Array of BtrfsSubvolumn objects |
The subvolume information. Array Length: 0 - 65535 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
uuid |
No |
String |
The UUID of the parent volume. Minimum: 0 Maximum: 255 |
|
is_snapshot |
No |
String |
Indicates whether the subvolume is a snapshot. Minimum: 0 Maximum: 255 |
|
subvol_id |
No |
String |
The subvolume ID. Minimum: 0 Maximum: 255 |
|
parent_id |
No |
String |
The parent volume ID. Minimum: 0 Maximum: 255 |
|
subvol_name |
No |
String |
The subvolume name. Minimum: 0 Maximum: 255 |
|
subvol_mount_path |
No |
String |
The mount path of the subvolume. Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
The disk information was updated. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. Minimum: 0 Maximum: 255 |
|
error_msg |
String |
The error message. Minimum: 0 Maximum: 255 |
|
encoded_authorization_message |
String |
The encrypted authorization information. Minimum: 0 Maximum: 65535 |
|
error_param |
Array of strings |
Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20 |
|
details |
Array of details objects |
The error details. Array Length: 1 - 20 |
Example Requests
This example updates the disk information of a server. The new disk name is /dev/vda, the disk function is BOOT, and the disk size is 42,949,672,960 bytes.
PUT https://{endpoint}/v3/sources/{source_id}/diskinfo
{
"disks" : [ {
"name" : "/dev/vda",
"device_use" : "BOOT",
"size" : 42949672960,
"partition_style" : "MBR",
"used_size" : 42948624384,
"physical_volumes" : [ {
"name" : "/dev/vda1",
"size" : 2153775104,
"device_use" : "NORMAL",
"used_size" : 2153775104,
"inode_size" : 0,
"file_system" : "swap",
"mount_point" : ""
}, {
"name" : "/dev/vda2",
"size" : 16862150656,
"device_use" : "BTRFS",
"used_size" : 16862150656,
"inode_size" : 0,
"file_system" : "btrfs",
"mount_point" : ""
}, {
"name" : "/dev/vda3",
"size" : 23932698624,
"device_use" : "NORMAL",
"used_size" : 33988608,
"inode_size" : 0,
"file_system" : "xfs",
"mount_point" : "/home"
} ]
}, {
"name" : "/dev/vdb",
"device_use" : "NORMAL",
"size" : 21474836480,
"partition_style" : "MBR",
"used_size" : 21473787904,
"physical_volumes" : [ {
"name" : "/dev/vdb1",
"size" : 21473787904,
"device_use" : "VOLUME_GROUP",
"used_size" : 21473787904,
"inode_size" : 0,
"file_system" : "LVM2_member",
"mount_point" : ""
} ]
}, {
"name" : "/dev/vdc",
"device_use" : "VOLUME_GROUP",
"size" : 21474836480,
"partition_style" : "MBR",
"used_size" : 0,
"physical_volumes" : [ ]
} ],
"volumegroups" : [ {
"name" : "vg1",
"size" : 42948624384,
"components" : "/dev/vdb1;/dev/vdc",
"logical_volumes" : [ {
"name" : "/dev/mapper/vg1-lv1",
"device_use" : "NORMAL",
"size" : 10737418240,
"free_size" : 10713837568,
"used_size" : 23580672,
"file_system" : "ext4",
"mount_point" : "/mnt/lv1",
"inode_size" : 256
} ]
} ],
"btrfs_list" : [ {
"name" : "/dev/vda2",
"label" : "none",
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"device" : "/dev/vda2",
"size" : "3.30GiB",
"nodesize" : 16384,
"sectorsize" : 4096,
"data_profile" : "single",
"system_profile" : "single",
"metadata_profile" : "single",
"global_reserve1" : "single",
"g_vol_used_size" : 3894038528,
"default_subvolid" : 259,
"default_subvol_name" : "@/.snapshots/1/snapshot",
"default_subvol_mountpath" : "/",
"subvolumn" : [ {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 257,
"parent_id" : 5,
"subvol_name" : "@",
"subvol_mount_path" : null
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 258,
"parent_id" : 257,
"subvol_name" : "@/.snapshots",
"subvol_mount_path" : "/.snapshots"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : true,
"subvol_id" : 259,
"parent_id" : 258,
"subvol_name" : "@/.snapshots/1/snapshot",
"subvol_mount_path" : "/"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 260,
"parent_id" : 257,
"subvol_name" : "@/boot/grub2/i386-pc",
"subvol_mount_path" : "/boot/grub2/i386-pc"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 261,
"parent_id" : 257,
"subvol_name" : "@/boot/grub2/x86_64-efi",
"subvol_mount_path" : "/boot/grub2/x86_64-efi"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 262,
"parent_id" : 257,
"subvol_name" : "@/opt",
"subvol_mount_path" : "/opt"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 263,
"parent_id" : 257,
"subvol_name" : "@/srv",
"subvol_mount_path" : "/srv"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 264,
"parent_id" : 257,
"subvol_name" : "@/tmp",
"subvol_mount_path" : "/tmp"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 265,
"parent_id" : 257,
"subvol_name" : "@/usr/local",
"subvol_mount_path" : "/usr/local"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 266,
"parent_id" : 257,
"subvol_name" : "@/var/cache",
"subvol_mount_path" : "/var/cache"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 267,
"parent_id" : 257,
"subvol_name" : "@/var/crash",
"subvol_mount_path" : "/var/crash"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 268,
"parent_id" : 257,
"subvol_name" : "@/var/lib/libvirt/images",
"subvol_mount_path" : "/var/lib/libvirt/images"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 269,
"parent_id" : 257,
"subvol_name" : "@/var/lib/machines",
"subvol_mount_path" : "/var/lib/machines"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 270,
"parent_id" : 257,
"subvol_name" : "@/var/lib/mailman",
"subvol_mount_path" : "/var/lib/mailman"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 271,
"parent_id" : 257,
"subvol_name" : "@/var/lib/mariadb",
"subvol_mount_path" : "/var/lib/mariadb"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 272,
"parent_id" : 257,
"subvol_name" : "@/var/lib/mysql",
"subvol_mount_path" : "/var/lib/mysql"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 273,
"parent_id" : 257,
"subvol_name" : "@/var/lib/named",
"subvol_mount_path" : "/var/lib/named"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 274,
"parent_id" : 257,
"subvol_name" : "@/var/lib/pgsql",
"subvol_mount_path" : "/var/lib/pgsql"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 275,
"parent_id" : 257,
"subvol_name" : "@/var/log",
"subvol_mount_path" : "/var/log"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 276,
"parent_id" : 257,
"subvol_name" : "@/var/opt",
"subvol_mount_path" : "/var/opt"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 277,
"parent_id" : 257,
"subvol_name" : "@/var/spool",
"subvol_mount_path" : "/var/spool"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : false,
"subvol_id" : 278,
"parent_id" : 257,
"subvol_name" : "@/var/tmp",
"subvol_mount_path" : "/var/tmp"
}, {
"uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"is_snapshot" : true,
"subvol_id" : 282,
"parent_id" : 258,
"subvol_name" : "@/.snapshots/2/snapshot",
"subvol_mount_path" : null
} ]
} ]
}
Example Responses
Status code: 200
The disk information was updated.
{ }
Status code: 403
Authentication failed.
{
"error_code" : "SMS.9004",
"error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
"encoded_authorization_message" : "XXXXXX",
"error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
"details" : [ {
"error_code" : "SMS.9004",
"error_msg" : "You do not have permission to perform action XXX on resource XXX."
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The disk information was updated. |
|
403 |
Authentication failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
