Метод list

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

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

 {
  "snapshots": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "storageSize": "string",
      "diskSize": "string",
      "productIds": [
        "string"
      ],
      "status": "string",
      "sourceDiskId": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
snapshots[] object

Ресурс Snapshot. Подробнее см. Снимки дисков.

snapshots[].
id
string

Идентификатор снимка.

snapshots[].
folderId
string

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

snapshots[].
createdAt
string (date-time)

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

snapshots[].
name
string

Имя снимка. Длина 1-63 символов.

snapshots[].
description
string

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

snapshots[].
labels
object

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

snapshots[].
storageSize
string (int64)

Размер снимка в байтах.

snapshots[].
diskSize
string (int64)

Размер диска в байтах в момент создания снимка.

snapshots[].
productIds[]
string

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

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

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

snapshots[].
status
string

Текущий статус снимка.

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

Идентификатор диска из которого создан этот снимок.

nextPageToken string

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