6.4. Showing image details¶
GET /v2/images/{image_id}
Show details of an image with the specified ID.
Source: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image
6.4.1. Request¶
Name | In | Type | Description |
---|---|---|---|
image_id |
path | string | The UUID of the image. |
6.4.1.1. Example¶
# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:9292/v2/images/c92d820c-50dc-4fd1-a0bc-2f1071487b67
6.4.2. Response¶
Name | In | Type | Description |
---|---|---|---|
checksum |
body | string | Hash that is used over the image data. The Image
service uses this value for verification. The value might be
null (JSON null data type). |
container_format |
body | enum | Format of the image container. Values may vary based on the configuration available in a particular OpenStack cloud. Example formats are: The value might be |
created_at |
body | string | The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
For example, The |
disk_format |
body | enum | The format of the disk. Values may vary based on the configuration available in a particular OpenStack cloud. See the Image Schema response from the cloud itself for the valid values available. Example formats are: The value might be |
file |
body | string | The URL for the virtual machine image file. |
id |
body | string | A unique, user-defined image UUID, in the format: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn
Where n is a hexadecimal digit from 0 to f, or F. For example: b2173dd3-7ad6-4362-baa6-a68bce3565cb
If you omit this value, the API generates a UUID for the image. |
min_disk |
body | integer | Amount of disk space in GB that is required to boot the image.
The value might be null (JSON null data type). |
min_ram |
body | integer | Amount of RAM in MB that is required to boot the image.
The value might be null (JSON null data type). |
name |
body | string | The name of the image. Value might be null (JSON null data type). |
os_hash_algo |
body | string | The algorithm used to compute a secure hash of the image data for this
image. The result of the computation is displayed as the value of the
os_hash_value property. The value might be null (JSON null
data type). The algorithm used is chosen by the cloud operator; it
may not be configured by end users. (Since Image API v2.7) |
os_hash_value |
body | string | The hexdigest of the secure hash of the image data computed using the
algorithm whose name is the value of the os_hash_algo property.
The value might be null (JSON null data type) if data has not
yet been associated with this image, or if the image was created using
a version of the Image Service API prior to version 2.7.
(Since Image API v2.7) |
os_hidden |
body | boolean | This field controls whether an image is displayed in the default image-list response. A “hidden” image is out of date somehow (for example, it may not have the latest updates applied) and hence should not be a user’s first choice, but it’s not deleted because it may be needed for server rebuilds. By hiding it from the default image list, it’s easier for end users to find and use a more up-to-date version of this image. (Since Image API v2.7) |
owner |
body | string | An identifier for the owner of the image, usually the project (also
called the “tenant”) ID.
The value might be null (JSON null data type). |
protected |
body | boolean | A boolean value that must be false or the image cannot be deleted. |
schema |
body | string | The URL for the schema describing a virtual machine image. |
self |
body | string | The URL for the virtual machine image. |
size |
body | integer | The size of the image data, in bytes. The value
might be null (JSON null data type). |
status |
body | string | The image status. |
tags |
body | array | List of tags for this image, possibly an empty list. |
updated_at |
body | string | The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
For example, The If the |
virtual_size |
body | integer | The virtual size of the image. The value might
be null (JSON null data type). |
visibility |
body | string | Image visibility, that is, the access permission for the image. |
direct_url (Optional) |
body | string | The URL to access the image file kept in external store. It is present
only if the show_image_direct_url option is true in the Image
service’s configuration file. Because it presents a security risk, this
option is disabled by default. |
locations (Optional) |
body | array | A list of objects, each of which describes an image location. Each object
contains a url key, whose value is a URL specifying a location, and a
metadata key, whose value is a dict of key:value pairs containing
information appropriate to the use of whatever external store is indicated
by the URL. This list appears only if the show_multiple_locations
option is set to true in the Image service’s configuration file.
Because it presents a security risk, this option is disabled by
default. |
6.4.2.1. Status codes¶
6.4.2.1.1. Success¶
Code | Reason |
---|---|
200 - OK |
Request was successful. |
6.4.2.1.2. Error¶
Code | Reason |
---|---|
400 - Bad Request |
Some content in the request was invalid. |
401 - Unauthorized |
User must authenticate before making a request. |
403 - Forbidden |
Policy does not allow current user to do this operation. |
404 - Not Found |
The requested resource could not be found. |
6.4.2.2. Example¶
{
"image_validated": "yes",
"container_format": "bare",
"min_ram": 0,
"updated_at": "2020-02-04T10:58:47Z",
"file": "/v2/images/c92d820c-50dc-4fd1-a0bc-2f1071487b67/file",
"owner": "f5d834d636c642c7bfe8af86139c6f26",
"id": "c92d820c-50dc-4fd1-a0bc-2f1071487b67",
"size": 12716032,
"os_distro": "linux",
"self": "/v2/images/c92d820c-50dc-4fd1-a0bc-2f1071487b67",
"disk_format": "qcow2",
"os_hash_algo": "sha512",
"direct_url": "file:///mnt/vstorage/vols/datastores/glance/c92d820c-<...>",
"hw_disk_bus": "virtio",
"schema": "/v2/schemas/image",
"status": "active",
"tags": [],
"trait:CUSTOM_HCI_122E856B9E9C4D80A0F8C21591B5AFCB": "required",
"visibility": "public",
"min_disk": 1,
"virtual_size": null,
"name": "cirros",
"checksum": "443b7623e27ecf03dc9e01ee93f67afe",
"created_at": "2020-01-28T12:58:17Z",
"os_hidden": false,
"protected": false,
"os_hash_value": "6513f21e44aa3da349f248188a<...>",
"os_type": "linux"
}