Метод list

Возвращает список доступных ресурсов Image в указанном каталоге.

HTTP-запрос

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

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка образов. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Image.name. 2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Должен содержать от 3 до 63 символов и соответствовать регулярному выражению ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "images": [
    {
      "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"
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
images[] object

Ресурс Image.

images[].
id
string

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

images[].
folderId
string

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

images[].
createdAt
string (date-time)

Строка в формате RFC3339.

images[].
name
string

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

images[].
description
string

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

images[].
labels
object

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

images[].
family
string

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

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

images[].
storageSize
string (int64)

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

images[].
minDiskSize
string (int64)

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

images[].
productIds[]
string

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

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

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

images[].
status
string

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

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

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

images[].
os.
type
string

Тип операционной системы. Значение по умолчанию — LINUX.

Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.

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

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.