• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Glance
  5. Common Parameters
  6. Image Attributes

Image Attributes

Description

An image is a template containing mandatory information for you to create a server or disk, such as the operating system (OS). The template may also contain application software, such as database software, and proprietary software. Image is the core object of IMS.

Image Attributes

Name

Type

Description

file

String

Specifies the URL for uploading and downloading the image file.

owner

String

Specifies the image owner.

id

String

Specifies the image ID.

size

Long

This parameter is unavailable currently.

self

String

Specifies the image URL.

schema

String

Specifies the image schema.

status

String

Specifies the image status. The value can be active, queued, saving, deleted, or killed. An image can be used only when it is in the active state.

tags

List<String>

Lists the image tags.

visibility

String

Specifies whether the image can be seen by other tenants. The value can be private, public, or shared.

name

String

Specifies the image name.

  • The name cannot start or end with space.
  • The name contains 1 to 128 characters.
  • The name contains the following four types of characters:
    • Uppercase letters
    • Lowercase letters
    • Numerals
    • Special characters include hyphens (-), periods (.), underscores (_), and spaces.

checksum

String

This parameter is unavailable currently.

deleted

Boolean

Specifies whether the image has been deleted. The value can be true or false.

protected

Boolean

Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.

container_format

String

Specifies the container type.

min_ram

Int

Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications limit. The default value is 0.

update_at

String

Specifies the time when the image was updated.

__os_bit

String

Specifies the OS architecture, 32 bit or 64 bit.

__os_version

String

Specifies the OS version.

__description

String

Provides supplementary information about the image.

The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed.

disk_format

String

Specifies the image format. The value can be vhd, raw, zvhd, or qcow2. The default value is vhd.

__isregistered

String

Specifies whether the image has been registered. The value can be true or false.

__platform

String

Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.

__os_type

String

Specifies the operating system type. The value can be Linux, Windows, or Other.

min_disk

Int

Specifies the minimum disk space (GB) required for running the image.

virtual_env_type

String

Specifies the environment where the image is used. The value can be FusionCompute, Ironic, or DataImage.

  • For an ECS image, set the value to FusionCompute.
  • For a data disk image, set the value to DataImage.
  • For a BMS image, set the value to Ironic.

__image_source_type

String

Specifies the image backend storage type. Only UDS is supported currently.

__imagetype

String

Specifies the 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.

create_at

String

Specifies the time when the image was created.

virtual_size

Int

This parameter is unavailable currently.

deleted_at

String

Specifies the time when the image was deleted.

__originalimagename

String

Specifies the parent image ID.

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

__backup_id

String

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

__productcode

String

Specifies the ID of the market image product.

__image_location

String

Specifies the location where the image is stored.

__image_size

String

Specifies the size (bytes) of the image file.

__data_origin

String

Specifies the image resource.

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

hw_frimware_type

String

Specifies the boot mode of an ECS. The following values are supported:

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

__support_xen

String

Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this attribute is not required.

__support_largememory

String

Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this attribute is not required.

__support_diskintensive

String

Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this attribute is not required.

__support_highperformance

String

Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this attribute is not required.

__support_xen_gpu_type

String

Specifies whether the image supports GPU-optimized ECSs on the Xen platform. See Table 2 for its value. For the supported OSs, see Table 3. If the image does not support GPU-optimized ECSs on the Xen platform, this attribute is not required. This attribute cannot co-exist with __support_xen.

__support_xen_hana

String

Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this attribute is not required.

This attribute cannot co-exist with __support_xen.

__support_kvm_infiniband

String

Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this attribute is not required.

This attribute cannot co-exist with __support_xen.