Image Attributes

file

String

URL for uploading and downloading an image file.

owner

String

Tenant that an image belongs to.

id

String

Image ID.

size

Long

This is a reserved field.

self

String

Image URL.

schema

String

Image schema.

status

String

Image status.

The value can be:

• queued: The image metadata has already been created, and it is ready to upload the image file.
• saving: The image file is being uploaded to the backend storage.
• deleted: The image has been deleted.
• killed: An error occurs on the image uploading.
• active: The image is available for use.

tags

Array of strings

Image tags.

visibility

String

Whether an image is visible to other tenants. The value can be private, public, or shared.

name

String

Image name.

• A name cannot start or end with a space.
• The name length must be 1 to 128 characters.
• The name contains the following characters:
  • Uppercase letters
  • Lowercase letters
  • Digits
  • Special characters, including hyphens (-), periods (.), underscores (_), and space

checksum

String

This is a reserved field.

deleted

Boolean

Whether an image has been deleted. The value can be true or false.

protected

Boolean

Whether an image is protected. A protected image cannot be deleted. The value can be true or false.

container_format

String

Container type.

min_ram

Integer

Minimum memory (MB) required for running an image. The parameter value depends on the ECS specifications. The default value is 0.

update_at

String

Image update time.

__os_bit

String

OS bitness. Generally, the value is 32 or 64.

__os_version

String

OS version.

__description

String

Image description.

The value contains a maximum of 1,024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed.

disk_format

String

Image format. The value can be zvhd2, vhd, zvhd, raw, iso, or qcow2. The default value is zvhd2 for a non-ISO image.

__isregistered

String

Whether an image is registered. The value can be true or false.

__platform

String

Image platform. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, CoreOS, EulerOS, or Other.

__os_type

String

OS type. The value can be Linux, Windows, or Other.

min_disk

Integer

Minimum disk space (GB) required for running an image.

max_ram

Integer

Maximum memory (MB) supported by an image.

virtual_env_type

String

Environment where an image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.

• For an ECS image (system disk image), the value is FusionCompute.
• For a data disk image, the value is DataImage.
• For a BMS image, the value is Ironic.
• For an ISO image, the value is IsoImage.

__image_source_type

String

Image backend storage type. Only UDS is supported currently.

__imagetype

String

Image type. The following types are supported:

• Public image: The value is gold.
• Private image: The value is private.
• Shared image: The value is shared.
• KooGallery image: The value is market.

__whole_image

Boolean

Whether an image is a full-ECS image. The value can be true or false.

create_at

String

Image creation time.

virtual_size

Integer

This is a reserved field.

deleted_at

String

Time when an image was deleted.

__originalimagename

String

Parent image ID.

If the image is a public image or created from an image file, this value is left empty.

__backup_id

String

Backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.

__productcode

String

Product ID of a KooGallery image.

__image_location

String

Image storage location.

__image_size

String

Image file size, in bytes.

__data_origin

String

Image source.

If the image is a public image, this parameter is left empty.

hw_firmware_type

String

ECS boot mode. The value can be:

• bios indicates the BIOS boot mode.
• uefi indicates the UEFI boot mode.

__support_kvm

String

Whether an image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.

__support_xen

String

Whether an image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.

__support_amd

String

Whether the image architecture is AMD. The value can be true or false.

__support_largememory

String

Whether an image supports large memory. If an image supports large memory, the value is true. Otherwise, this parameter is not required.

__support_diskintensive

String

Whether an image supports intensive storage. If an image supports intensive storage, the value is true. Otherwise, this parameter is not required.

__support_highperformance

String

Whether an image supports high-performance computing. If an image supports high-performance computing, the value is true. Otherwise, this parameter is not required.

__support_xen_gpu_type

String

Whether an image supports GPUs on the Xen platform. For the supported OSs, see Table 2. If an image does not support GPUs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen or __support_kvm.

__support_kvm_gpu_type

String

Whether an image supports GPUs on the KVM platform. See Table 3 for its value.

If an image does not support GPUs on the KVM platform, this parameter is not required. This parameter cannot co-exist with __support_xen or __support_kvm.

__support_xen_hana

String

If an image supports HANA on the Xen platform, the value is true. Otherwise, this parameter is not required.

This parameter cannot co-exist with __support_xen or __support_kvm.

__support_kvm_infiniband

String

If an image supports InfiniBand NICs on the KVM platform, the value is true. Otherwise, this parameter is not required.

This attribute cannot co-exist with __support_xen.

__support_fc_inject

String

Whether an image supports password/private key injection with Cloud-Init. If the value is set to true, the injection is not supported. Otherwise, it is supported.

__is_config_init

String

Whether initial configuration is completed. The value can be true or false.

If initial configuration is complete, the value is set to true. Otherwise, the value is set to false. The default value is false.

enterprise_project_id

String

Enterprise project that an image belongs to.

• If the value is 0 or left blank, the image belongs to the default enterprise project.
• If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

__support_kvm_hi1822_hisriov

String

Whether an image supports SR-IOV passthrough. If yes, the value is true. Otherwise, this parameter is not required.

__support_kvm_hi1822_hivirtionet

String

Whether an image supports VirtIO-Net passthrough. If yes, the value is true. Otherwise, this parameter is not required.