DescribeImages
In this article:
DescribeImages#
Description#
Requests the list of available images.
Request Parameters#
ExecutableBy.N — Filters the images by users with explicit launch permissions.
Type: Array of strings
Valid values:
self
|all
|<project_name>
Required: No
Filter.N — One or more filters.
Type: List of Filter objects
Required: No
ImageId.N — The image IDs.
Type: Array of strings
Required: No
Owner.N — Filters the images by the owner.
Type: Array of strings
Valid values:
self
|templates@company
|<project_name>
Required: No
Supported Filters#
description — The description of the image.
image-id — The image ID.
Name — The name of the image.
is-public — A Boolean attribute that indicates whether the image is public.
owner-alias — The alias of the image owner (for example,
cloud_provider
).owner-id — The ID of the image owner.
platform — The platform (for example,
generic
,redhat
).state — The state of the image.
tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.
tag-key — The tag key. This filter is used to get all images with the specified tag key and any tag value.
type — The image type (
regular
|backup
).virtualization-type — The virtualization type (
hvm
|hvm-legacy
).
Response Elements#
imageSet — Information about the images.
Type: List of Image objects
requestId — The request ID.
Type: String
Examples#
c2-ec2 DescribeImages Owner.1 self ImageId.1 <image_id>
c2-ec2 DescribeImages ExecutableBy.1 <project_name1> ExecutableBy.2 <project_name2>
c2-ec2 DescribeImages Filter.1.Key tag:<tag-key> Filter.1.Value "tag-value"