Метод list

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

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

 {
  "disks": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "typeId": "string",
      "zoneId": "string",
      "size": "string",
      "productIds": [
        "string"
      ],
      "status": "string",
      "instanceIds": [
        "string"
      ],

      // `disks[]`включает только одно из полей `sourceImageId`, `sourceSnapshotId`
      "sourceImageId": "string",
      "sourceSnapshotId": "string",
      // конец списка возможных полей`disks[]`

    }
  ],
  "nextPageToken": "string"
}
Поле Описание
disks[] object

Ресурс Disk. Подробнее см. Диски.

disks[].
id
string

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

disks[].
folderId
string

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

disks[].
createdAt
string (date-time)

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

disks[].
name
string

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

disks[].
description
string

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

disks[].
labels
object

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

disks[].
typeId
string

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

disks[].
zoneId
string

Идентификатор зоны доступности, где находится диск.

disks[].
size
string (int64)

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

disks[].
productIds[]
string

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

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

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

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

Массив виртуальных машин, к которым подключен диск.

disks[].
sourceImageId
string
disks[] включает только одно из полей sourceImageId, sourceSnapshotId

Идентификатор образа, из которого был создан диск.

disks[].
sourceSnapshotId
string
disks[] включает только одно из полей sourceImageId, sourceSnapshotId

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

nextPageToken string

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