Image
Overview
An image is an image template used by a VM instance or volume.
- Image templates include root volume images and data volume images.
- Root volume images can be in the format of ISO or Image, while data volume images can be in the format of Image.
- The Image format can either be raw or qcow2.
- Images are stored on backup storage. If you are creating VM instances or volumes for the first time, the images will be downloaded to primary storage and stored as image caches.
When you create a VM instance, the type of the image platform decides whether to use a KVM Virtio driver (including disk driver and NIC driver). The supported image platforms are as follows:
- Linux: Uses a Virtio driver.
- Windows: Not to use a Virtio driver. Instead, QEMU is used. The image operating system is a Windows OS without a Virtio driver installed.
- WindowsVirtio: Uses a Virtio driver. The image operating system is a Windows OS with a Virtio driver (including disk driver and NIC driver) installed.
- Other: Not to use a Virtio driver. Instead, QEMU is used. The image operating system can be of any types.
- Paravirtualization: Uses a Virtio driver. The image operating system can be any operating system with a Virtio driver installed.
To add an image, add a URL or upload a local file.
URL: Adds an image through the specified URL.
HTTP/HTTPS:
- Format: http://path/file or https://path/file
- Example: http://example.com/image.qcow2
FTP:
Anonymous format: ftp://hostname[:port]/path/file
Example: ftp://172.20.0.10/pub/zstack-image.qcow2
Non-anonymous format: ftp://user:password@hostname[:port]/path/file
Example: ftp://zstack:password@172.20.0.10/pub/zstack-image.qcow2
SFTP:
Format with password specified: sftp://user:password@hostname[:port]/path/file
Example: sftp://root:password@172.20.0.10/pub/zstack-image.qcow2
Password-free format: sftp://user@hostname[:port]/path/file
Example: sftp://root@172.20.0.10/pub/zstack-image.qcow2
The absolute path on backup storage, which supports SFTP backup storage and ImageStore.
Example:
file:///opt/zstack-dvd/zstack-image-1.4.qcow2
Before you enter a URL, make sure that the URL can be accessed by a backup storage and the corresponding backup storage file exists.
Before you upload an image by using the SFTP password-free method, make sure that password-free SSH access can be achieved between a backup storage and the SFTP server.
Smooth, continuous display of progress bar, and breakpoint resume:
- The ImageStore backup storage supports smooth, continuous display of progress bar, and breakpoint resume.
- The Ceph backup storage supports smooth, continuous display of progress bar, but does not support breakpoint resume.
- The SFTP backup storage does not support smooth, continuous display of progress bar, or breakpoint resume.
If you upload an image by using
file:///, make sure that:- The Ceph backup storage currently does not support the file:/// format.
- The
file:///path contains three forward slashes (/), which correspond to the absolute path of the backup storage. For example,file:///opt/zstack-dvd/zstack-image-1.4.qcow2. The zstack-image-1.4.qcow2 file needs to be stored in the/opt/zstack-dvddirectory of the backup storage.
Upload a local file: You can upload an image that can be accessed by your current browser. Both ImageStore and Ceph backup storages are supported.
When you add an image by uploading a local file, you use the local browser as a transit point. Therefore, do not refresh or close the current browser, and do not stop the management node service. Otherwise, the image might fail to be added.
Inventory
Properties
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 0.6 | ||
| name | The name. For more information, see Resource Property. | 0.6 | ||
| description | The description. For more information, see Resource Property. | Yes | 0.6 | |
| state | The state. For more information, see State. |
|
0.6 | |
| status | The status. For more information, see Status. |
|
0.6 | |
| size | The image size. Unit: byte. | 0.6 | ||
| url | The URL from which the image is registered. For more information, see URL. | 0.6 | ||
| mediaType | The image media type. For more information, see Media Type. |
|
0.6 | |
| guestOsType | The string that describes the operating system type of a VM instance. | Yes | 0.6 | |
| platform | The platform of a VM instance’s operating system. For more information, see Platform. |
|
0.6 | |
| architecture | The image architecture. | Yes |
|
5.0.0 |
| system | Whether the image is a system image. For more information, see System Image. | 0.6 | ||
| format | The format. For more information, see Format. |
|
0.6 | |
| md5Sum | The MD5 checksum of the image. | 0.6 | ||
| type | The reserved field. |
|
0.6 | |
| actualSize | The actual size. | 0.6 | ||
| exportMd5Sum | 0.6 | |||
| exportUrl | 0.6 | |||
| virtio | Whether virtio is supported or not. | 5.0.0 | ||
| backupStorageRefs | The backup storage references. For more information, see Back Storage Reference. | 0.6 | ||
| createDate | The creation date. For more information, see Resource Property. | 0.6 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 0.6 |
Sample
{
"inventories": [
{
"actualSize": 293641216,
"backupStorageRefs": [
{
"backupStorageUuid": "ae840e03a0044b759b0a8c09a141a46b",
"createDate": "Oct 30, 2017 4:32:11 PM",
"imageUuid": "fccc12fee6a411d68c42763ded705630",
"installPath": "zstore://fccc12fee6a411d68c42763ded705630/b08ea6cad1f10217223192343a1d8fb72279ed47",
"lastOpDate": "Oct 30, 2017 4:32:11 PM",
"status": "Ready"
}
],
"createDate": "Oct 30, 2017 4:32:11 PM",
"description": "",
"exportMd5Sum": "9b38fe1fd43385b86a1c9b12ac1960fe",
"exportUrl": "http://10.0.146.122:8001/imagestore/download/image-b08ea6cad1f10217223192343a1d8fb72279ed47.qcow2",
"format": "qcow2",
"lastOpDate": "Oct 30, 2017 7:35:38 PM",
"md5Sum": "42e98b8fc79cd8aeffe1b34a2a7021fed621eec0be926139d46e8afc26e78b7d",
"mediaType": "RootVolumeTemplate",
"name": "vr-test-2",
"platform": "Linux",
"size": 8589934592,
"state": "Enabled",
"status": "Ready",
"system": true,
"type": "zstack",
"url": "http://192.168.200.100/mirror/diskimages/cloud-vrouter-latest.qcow2",
"uuid": "fccc12fee6a411d68c42763ded705630"
}
],
"success": true
}
State
An image has the following two states:
Enabled:
Indicates that VM instances can be created from this image.
Disabled:
Indicates that VM instances cannot be created from this image.
Status
Status indicates the lifecycle of an image.
Creating:
Indicates that the image is being created from a volume, and is not ready to use.
Downloading:
Indicates that the image is being downloaded from a URL, and is not ready to use.
Ready:
Indicates that the image already exists in backup storage, and is ready to use.
URL
The meaning of a URL varies depending on how an image was created on a backup storage.
If the image was downloaded from a web server, the URL is an HTTP/HTTPS link.
If the image was created from a volume or a volume snapshot, the URL is a string encoding UUID of the volume or the volume snapshot. For example,
volume://b395386bdb4a4ff1b1850a457c949c5e volumeSnapshot://b395386bdb4a4ff1b1850a457c949c5e
Media Type
Media type indicates how an image will be used.
RootVolumeTemplate:
This type of image is used to create root volumes.
DataVolumeTemplate:
This type of image is used to create data volumes.
ISO:
ISO images are used to install operating systems on blank root volumes.
Platform
Platform gives ZStack Cloud a hint that whether to use paravirtualization.
| Use paravirtualization |
|
|---|---|
| Not to use paravirtualization (The VM instance disk uses the IDE mode, and the NIC uses e1000.) |
|
System Image
System images are used only for appliance VM instances, not for user VM instances.
Format
Format reveals the relationship between hypervisors and images. For example, images of qcow2 format can only be used for KVM VM instances. The current version of ZStack Cloud supports only KVM hypervisors. The relationship is as follows.
| Hypervisor Type | Format |
|---|---|
| KVM |
|
Volumes will inherit formats of images from which they are created. For example, the root volumes created from images of qcow2 format will also have the qcow2 format. The raw format is an exception. The volumes created from raw images will have the qcow2 format because ZStack Cloud will perform thin clone by using the qcow2 format.
Backup Storage Reference
An image can be stored on more than one backup storage. For each backup storage, the image has a backup storage reference that includes the backup storage UUID and the image installation path.
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageUuid | The image UUID. | 0.6 | ||
| backupStorageUuid | The backup storage UUID. For more information, see Backup Storage. | 0.6 | ||
| installPath | The installation path on the backup storage. | 0.6 | ||
| createDate | The creation date. For more information, see Resource Property. | 0.6 | ||
| exportUrl | Exporting the url of the image. | 5.0.0 | ||
| exportMd5Sum | Exporting the MD5 value of the image. | 5.0.0 | ||
| status | The image ready status. | 5.0.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 0.6 |
Sample
{
"backupStorageUuid": "ae840e03a0044b759b0a8c09a141a46b",
"createDate": "Oct 30, 2017 4:32:11 PM",
"imageUuid": "fccc12fee6a411d68c42763ded705630",
"installPath": "zstore://fccc12fee6a411d68c42763ded705630/b08ea6cad1f10217223192343a1d8fb72279ed47",
"lastOpDate": "Oct 30, 2017 4:32:11 PM",
"status": "Ready"
}
Operations
AddImage
Adds an image. For example,
AddImage name=testimage url=http://192.168.200.100/mirror/diskimages/CentOS6-test-image-4G.qcow2 \
system=false format=qcow2 platform=Linux backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f \
mediaType=RootVolumeTemplate
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The image name. | 0.6 | ||
| description | The detailed description of the image. | Yes | 0.6 | |
| url | The URL of the image to be added. | 0.6 | ||
| mediaType | The image type. | Yes |
|
0.6 |
| guestOsType | The operating system type of the guest VM instance that corresponds to the image. | Yes | 0.6 | |
| system | Whether the image is a system image. | Yes | 0.6 | |
| format | The image format. |
|
0.6 | |
| platform | The operating system platform of the image. | Yes |
|
0.6 |
| backupStorageUuids | The UUID list of the backup storages on which the image is to be added. | 0.6 | ||
| type | The reserved field for internal use. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as UUID. | Yes | 0.6 | |
| tagUuids | The tag UUIDs. | 4.0.0 | ||
| architecture | The image architecture. | Yes |
|
4.0.0 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | 0.6 | ||
| timeout | Yes |
DeleteImage
Deletes an image. For example,
DeleteImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f uuid=d10dd071a8b04c5aa4a8d98a83c1f979 \
deleteMode=Permissive
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| backupStorageUuids | The backup storage UUID list. | Yes | 0.6 | |
| deleteMode | The delete mode. For more information, see Delete Resources. | Yes |
|
0.6 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
ExpungeImage
Completely deletes an image. For example,
ExpungeImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f \
imageUuid=d10dd071a8b04c5aa4a8d98a83c1f979
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageUuid | The image UUID. | 0.6 | ||
| backupStorageUuids | The backup storage UUID list. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
QueryImage
Queries an image. For example,
QueryImage status=Ready system=true
QueryImage volume.vmInstanceUuid=85ab231e392d4dfb86510191278e9fc3
Primitive Fields of Query
See Image Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| backupStorage | Backup Storage Inventory | The backup storage where the image is located. | 0.6 |
| volume | Volume Inventory | The volumes that are created from the image. | 0.6 |
| backupStorageRefs | Backup Storage Reference | The reference that is used to query the backup storage installation path. | 0.6 |
RecoverImage
Recovers an image that is deleted (but not expunged). For example,
RecoverImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f \
imageUuid=2aa6ae40c4954143be0ecb9a6a160b5b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageUuid | The image UUID. | 0.6 | ||
| backupStorageUuids | The backup storage UUID list. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
ChangeImageState
Changes the image state. For example,
ChangeImageState uuid=2aa6ae40c4954143be0ecb9a6a160b5b stateEvent=disable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| stateEvent | The state of the image. |
|
0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
UpdateImage
Updates an image. For example,
UpdateImage uuid=2aa6ae40c4954143be0ecb9a6a160b5b name=new-image
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| name | The image name. | Yes | 0.6 | |
| description | The detailed description of the image. | Yes | 0.6 | |
| mediaType | The image type. | Yes |
|
0.6 |
| guestOsType | The operating system type of the guest VM instance that corresponds to the image. | Yes | 0.6 | |
| system | Whether the image is a system image. | Yes | 0.6 | |
| format | The image format. | Yes |
|
0.6 |
| platform | The operating system platform of the image. | Yes |
|
0.6 |
| architecture | Yes |
|
4.0.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
SyncImageSize
Synchronizes the image size. For example,
SyncImageSize uuid=2aa6ae40c4954143be0ecb9a6a160b5b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
DeleteImagePackage
Deletes an image package. For example,
DeleteImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 4.4.6 | ||
| deleteMode | Yes | 4.4.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.4.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.4.6 | |
| timeout | Yes |
UpdateImagePackage
Updates an image package. For example,
UpdateImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 4.4.6 | ||
| name | The resource name. | Yes | 4.4.6 | |
| description | The resource description. | Yes | 4.4.6 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.4.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.4.6 | |
| timeout | Yes |
QueryImagePackage
Query image packages.
QueryImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b
Primitive Fields of Query
See image inventory.
Nested And Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| backupStorage | backup storage inventory | The backup storage. | 4.4.6 |
| vmInstance | vmInstance inventory | The VM instance. | 4.4.6 |
GetCandidateBackupStorageForCreatingImage
Obtains the candidate backup storages that can be used to create images. For example,
GetCandidateBackupStorageForCreatingImage volumeUuid=493a22431c434505b49afb16a5a6cda6
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| volumeUuid | The volume UUID. Make sure that at least one of volumeUuid and volumeSnapshotUuid is not null. | Yes | 0.6 | |
| volumeSnapshotUuid | The volume snapshot UUID. Make sure that at least one of volumeUuid and volumeSnapshotUuid is not null. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
CreateRootVolumeTemplateFromRootVolume
Creates a root volume image from a root volume. For example,
CreateRootVolumeTemplateFromRootVolume rootVolumeUuid=cc83fc9639cf456c8e43c35f6d2d52cd \
backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f name=new-rootvolume
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The name of the root volume image. | 0.6 | ||
| description | The detailed description of the root volume image. | Yes | 0.6 | |
| guestOsType | The operating system type of the guest VM instance that corresponds to the root volume image. | Yes | 0.6 | |
| backupStorageUuids | The backup storage UUID list. | Yes | 0.6 | |
| rootVolumeUuid | The root volume UUID. | Yes | 0.6 | |
| platform | The operating system platform of the root volume image. | Yes |
|
0.6 |
| system | Whether the root volume image is a system root volume image. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the root volume image will use the specified value as UUID. | Yes | 0.6 | |
| architecture | Yes | 4.0.0 | ||
| tagUuids | The tag UUIDs. | Yes | 4.0.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
When you create an image from a root volume, ZStack Cloud copies the value of the GuestTools tag from VM instance to image. When you use this image to create a VM instance, the value of the GuestTools tag will be copied from the image to the target VM instance. Note that you can add the GuestTools option to SystemTags.
- Format of the GuestTools option:
GuestTools::TOOLS_VERSION. Here, the initial value of TOOLS_VERSION is 1.0.0. This value will change as the version of GuestTools is upgraded. - Example:
GuestTools::1.0.0 - Note: When you create an image from the root volume of a VM instance, the value of the GuestTools tag will be copied from the VM instance to the target image.
- Format of the GuestTools option:
CreateRootVolumeTemplateFromVolumeSnapshot
Creates a root volume image from a volume snapshot. For example,
CreateRootVolumeTemplateFromVolumeSnapshot name=root-volume-template \
snapshotUuid=30a129c7f06243499b1ed5ec9e4a778e backupStorageUuids=e05cad1e1e3a4778a3a0b57cddd847f3
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The name of the root volume image. | 0.6 | ||
| description | The detailed description of the root volume image. | Yes | 0.6 | |
| guestOsType | The operating system type of the guest VM instance that corresponds to the root volume image. | Yes | 0.6 | |
| backupStorageUuids | The backup storage UUID list. | 0.6 | ||
| snapshotUuid | The snapshot UUID. | 0.6 | ||
| platform | The operating system platform of the root volume image. | Yes |
|
0.6 |
| system | Whether the root volume image is a system root volume image. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the root volume image will use the specified value as UUID. | Yes | 0.6 | |
| architecture | Yes | 4.0.0 | ||
| tagUuids | The tag UUIDs. | Yes | 4.0.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
CreateDataVolumeTemplateFromVolume
Creates a data volume image from a volume. For example,
CreateDataVolumeTemplateFromVolume name=test \
volumeUuid=3eb74bba9a5448368158c2ee6f0a61ef
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| volumeUuid | The UUID of the volume from which the data volume image is to be created. | 0.6 | ||
| name | The name of the data volume image. | 0.6 | ||
| description | The detailed description of the data volume image. | Yes | 0.6 | |
| backupStorageUuids | The backup storage UUID list. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the data volume image will use the specified value as UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
CreateDataVolumeTemplateFromVolumeSnapshot
Creates a data volume image from a volume snapshot. For example,
CreateDataVolumeTemplateFromVolumeSnapshot name=data-volume-template \
snapshotUuid=30a129c7f06243499b1ed5ec9e4a778e backupStorageUuids=e05cad1e1e3a4778a3a0b57cddd847f3
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The name of the data volume image. | 0.6 | ||
| description | The detailed description of the data volume image. | Yes | 0.6 | |
| guestOsType | The operating system type of the guest VM instance that corresponds to the data volume image. | Yes | 0.6 | |
| backupStorageUuids | The backup storage UUID list. | 0.6 | ||
| snapshotUuid | The snapshot UUID. | 0.6 | ||
| platform | The operating system platform of the data volume image. | Yes |
|
0.6 |
| system | Whether the data volume image is a system data volume image. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the data volume image will use the specified value as UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
GetImageQga
Obtains the image QGA. For example,
GetImageQga uuid=0ed799bb11b940229e97b1fc0b09a7d3
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
SetImageQga
Sets the image QGA. For example,
SetImageQga enable=true uuid=0ed799bb11b940229e97b1fc0b09a7d3
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 0.6 | ||
| enable | 0.6 | |||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is ImageVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is ImageVO. | Yes | 0.6 | |
| timeout | Yes |
SetImageBootMode
Sets the image boot mode. For example,
SetImageBootMode uuid=4efcba4c12cc35f4a1b262038f7e7b80 bootMode=Legacy
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The image UUID. | 3.9.0 | ||
| bootMode | The image boot mode. |
|
3.9.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.9.0 | |
| systemTags | The system tags. For more information, seeCreateSystemTag. | Yes | 3.9.0 | |
| timeout | Yes |
GetUploadImageJobDetails
Retrieves the details of a image upload job. For example,
GetUploadImageJobDetails imageId=4efcba4c12cc35f4a1b262038f7e7b80
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| imageId | The user-defined image ID. We recommend that you use an MD5 value. | 4.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.1.0 | |
| timeout | Yes |
CalculateImageHash
Retrieves the details of a image upload job. For example,
CalculateImageHash uuid=cff188348a714d1d87b92e95ee13b248 backupStorageUuid=97626ef683be4c79af44fb7b75813a38
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource uuid. | 5.0.0 | ||
| backupStorageUuid | The backup storage uuid. | 5.0.0 | ||
| algorithm | Yes | 5.0.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 5.0.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 5.0.0 | |
| timeout | Yes |
Tags
You can create a user tag on an image by using resourceType=ImageVO. For example,
CreateUserTag resourceType=ImageVO tag=golden-image \
resourceUuid=ff7c04c4e2874a21a3e795501f1bc516
