Метод get

Возвращает указанный ресурс Image.

Чтобы получить список доступных ресурсов Image, используйте запрос list.

HTTP-запрос

GET https://compute.api.cloud.yandex.net/compute/v1/images/{imageId}

Path-параметры

Параметр Описание
imageId Обязательное поле. Идентификатор возвращаемого ресурса Image. Чтобы получить идентификатор образа, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

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

Ресурс Image

Поле Описание
id string

Идентификатор образа.

folderId string

Идентификатор каталога, которому принадлежит образ.

createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

name string

Название образа. Длина 1-63 символов.

description string

Описание образа. Длина описания должна быть от 0 до 256 символов.

labels object

Метки ресурса в формате ключ:значение. Максимум 64 на ресурс.

family string

Имя семейства образов, к которому принадлежит этот образ.

Вы можете получить самый последний образ семейства с помощью запроса getLatestByFamily и создать диск из этого образа.

storageSize string (int64)

Размер образа в байтах.

minDiskSize string (int64)

Минимальный размер диска, который будет создан из этого образа.

productIds[] string

Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины.

Правильный идентификатор лицензии генерируется Яндекс.Облаком. Новые ресурсы, созданные из этого ресурса, унаследуют идентификаторы от него.

Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если вы создадите образ диска с помощью сторонней утилиты и загрузите его в Yandex Object Storage, идентификаторы лицензий будут потеряны. Вы можете указать их в запросе create .

status string

Текущий статус образа.

  • CREATING: Образ создается.
  • READY: Образ готов к использованию.
  • ERROR: С образом произошла ошибка, блокирующая работу.
  • DELETING: Образ удаляется.
os object

Операционная система, которая содержится в образе.

os.
type
string

Тип операционной системы.

  • LINUX: Операционная система Linux.
  • WINDOWS: Операционная система Windows.