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.
  • Enabled
  • Disabled
 0.6
status The status. For more information, see Status.
  • Creating
  • Downloading
  • Ready
 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.
  • RootVolumeTemplate
  • DataVolumeTemplate
  • ISO
 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.
  • Linux
  • Windows
  • Paravirtualization
  • Other
 0.6
system Whether the image is a system image. For more information, see System Image. 0.6
format The format. For more information, see Format.
  • qcow2
  • raw
 0.6
md5Sum The MD5 checksum of the image. 0.6
type The reserved field.
  • zstack
 0.6
actualSize The actual size. 0.6
exportMd5Sum 0.6
exportUrl 0.6
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
  • Linux
  • Paravirtualization
Not to use paravirtualization (The VM instance disk uses the IDE mode, and the NIC uses e1000.)
  • Windows
  • Other

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
  • qcow2
  • raw

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
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"
                }