.. _DescribeImages:

##############
DescribeImages
##############

***********
Description
***********

Запрос на получение списка доступных образов.

******************
Request Parameters
******************

- *ExecutableBy.N* — Ограничить выборку образов по пользователям, которым явно предоставлены права на использование.

  - Тип: Array of strings
  - Возможные значения: ``self`` | ``all`` | ``<project_name>``
  - Необходимо: Нет

- *Filter.N* — Параметры фильтрации.

  - Тип: Список объектов :ref:`Filter`
  - Необходимо: Нет

- *ImageId.N* — Идентификаторы образов.

  - Тип: Array of strings
  - Необходимо: Нет

- *Owner.N* — Ограничить выборку образов по владельцам образов.

  - Тип: Array of strings
  - Возможные значения: ``self`` | ``templates@company`` | ``<project_name>``
  - Необходимо: Нет

Supported Filters
=================

- *description* — Описание снимка диска.
- *image-id* — Идентификатор образа.
- *image-name* — Имя образа.
- *is-public* — Boolean, определяющий, открыт ли к образу общий доступ.
- *owner-alias* — Алиас владельца снимка диска (например, ``cloud_provider``).
- *owner-id* — Идентификатор владельца образа.
- *platform* — Платформа (например, ``generic``, ``redhat``).
- *state* — Состояние образа.
- *tag:<tag-key>* — Пара ключ/значение тега. Ключ тега передаётся в названии фильтра, значение тега — в значении фильтра.
- *tag-key* — Ключ тега. Такой фильтр позволяет получить образы с тегом с указанным ключом и любым значением.
- *virtualization-type* — Тип виртуализации (``hvm`` | ``hvm-legacy``).

*****************
Response Elements
*****************

- *imageSet* — Информация об образах.

  - Тип: Список объектов :ref:`Image`

- *requestId* — Идентификатор запроса.

  - Тип: String

********
Examples
********

.. code-block:: bash

   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"