Метод create

HTTP-запрос
Параметры в теле запроса
Ответ

Создает образ в указанном каталоге.

Вы можете создать образ из диска, снимка, другого образа или URI. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.

HTTP-запрос

POST https://compute.api.cloud.yandex.net/compute/v1/images

Параметры в теле запроса

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "family": "string",
  "minDiskSize": "string",
  "productIds": [
    "string"
  ],
  "os": {
    "type": "string"
  },

  //  включает только одно из полей `imageId`, `diskId`, `snapshotId`, `uri`
  "imageId": "string",
  "diskId": "string",
  "snapshotId": "string",
  "uri": "string",
  // конец списка возможных полей

}

Поле	Описание
folderId	string Обязательное поле. Идентификатор каталога для создания образа. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
name	string Имя образа. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Описание образа. Максимальная длина строки в символах — 256.
labels	object Метки ресурса в формате `ключ:значение`. Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
family	string Имя семейства образов, к которому принадлежит этот образ. Дополнительные сведения см. в разделе Семейство образов. Чтобы получить информацию о последнем образе в семействе, используйте запрос getLatestByFamily. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
minDiskSize	string (int64) Минимальный размер диска, который будет создан из этого образа. Указывается в байтах. Значение должно быть больше размера исходных данных. Допустимые значения — от 4194304 до 4398046511104 включительно.
productIds[]	string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в этом запросе. Максимальная длина строки в символах для каждого значения — 50.
os	object Операционная система, содержащаяся в образе. По умолчанию наследуется от исходного ресурса, если в качестве источника вы использовали `image_id` или `disk_id`.
os. type	string Тип операционной системы. Значение по умолчанию — `LINUX`. Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины. LINUX: Операционная система Linux. WINDOWS: Операционная система Windows.
imageId	string включает только одно из полей `imageId`, `diskId`, `snapshotId`, `uri` Идентификатор образа, из которого будет создан новый образ. Максимальная длина строки в символах — 50.
diskId	string включает только одно из полей `imageId`, `diskId`, `snapshotId`, `uri` Идентификатор диска, из которого будет создан образ. Максимальная длина строки в символах — 50.
snapshotId	string включает только одно из полей `imageId`, `diskId`, `snapshotId`, `uri` Идентификатор снимка, из которого будет создан образ. Максимальная длина строки в символах — 50.
uri	string включает только одно из полей `imageId`, `diskId`, `snapshotId`, `uri` URI образа, из которого будет создан новый образ. В настоящее время поддерживаются только ссылки на образы, которые хранятся в Yandex Object Storage. В настоящее время поддерживаются только форматы Qcow2, VMDK и VHD.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

Поле	Описание
id	string Идентификатор операции.
description	string Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt	string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339.
createdBy	string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt	string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339.
done	boolean (boolean) Если значение равно `false` — операция еще выполняется. Если `true` — операция завершена, и задано значение одного из полей `error` или `response`.
metadata	object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `metadata`.
error	object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей `error`, `response` Описание ошибки в случае сбоя или отмены операции.
error. code	integer (int32) Код ошибки. Значение из списка google.rpc.Code.
error. message	string Текст ошибки.
error. details[]	object Список сообщений с подробными сведениями об ошибке.
response	object включает только одно из полей `error`, `response` Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `response`.