.. _RegisterImage:

#############
RegisterImage
#############

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

Запрос на создание образа.

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

Необходимые параметры
=====================

- *Name* — Имя образа.

  - Тип: String
  - Необходимо: Да
  - Ограничение: Длина 3-128 символов ASCII, скобки ``()``, квадратные скобки ``[]``, пробелы ``" "``, точки ``.``, слэши ``/``, дефисы ``-``, одинарные кавычки ``'``, знаки ``@`` или нижние подчёркивания ``_``

Опциональные параметры
======================

- *Architecture* — Тип архитектуры образа экземпляра.

  - Необходимо: Нет
  - Тип: String
  - Возможные значения: ``x86_64``

- *BlockDeviceMapping.n.Ebs.DeleteOnTermination* — Указатель на удаление диска при удалении экземпляра.

  - Необходимо: Нет
  - Тип: Boolean

- *BlockDeviceMapping.n.Ebs.Iops* — Количество операций чтения/записи в секунду.

  - Необходимо: Нет
  - Тип: Integer
  - Ограничение: Только для дисков с типом ``io2``

- *BlockDeviceMapping.n.Ebs.SnapshotId* — Идентификатор снимка диска.

  - Необходимо: Нет
  - Тип: String

- *BlockDeviceMapping.n.Ebs.VolumeSize* — Размер виртуального диска.

  - Необходимо: Нет
  - Тип: Integer

- *BlockDeviceMapping.n.Ebs.VolumeType* — Тип виртуального диска.

  - Необходимо: Нет
  - Тип: String
  - Значение по умолчанию: st2
  - Возможные значения: ``st2`` | ``gp2`` | ``io2``

- *BlockDeviceMapping.n.VirtualName* — **Не поддерживается**

- *BlockDeviceMapping.n.DeviceName* — Имя блочного устройства.

  - Необходимо: Нет
  - Тип: String
  - Возможные значения: ``disk<N>`` | ``cdrom<N>`` | ``floppy<N>``

- *Description* — Описание образа экземпляра.

  - Необходимо: Нет
  - Тип: String

- *ImageLocation* — **Не поддерживается**

- *RootDeviceName* — Имя корневого (загрузочного) устройства экземпляра.

  - Необходимо: Нет
  - Тип: String
  - Возможные значения: ``disk<N>`` | ``cdrom<N>`` | ``floppy<N>`` | ``menu``
  - Значение по умолчанию: ``disk1``

- *VirtualizationType* — Тип виртуализации образа экземпляра.

  - Необходимо: Нет
  - Тип: String

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

- *imageId* — Идентификатор созданного образа.

  - Тип: String

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

  - Тип: String

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

.. code-block:: bash

   c2-ec2 RegisterImage Description "<description>" <block_device_mapping>