Метод get

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

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

HTTP-запрос

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

Path-параметры

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

Ответ

HTTP Code: 200 - OK

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

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

}

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

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

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

folderId string

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

createdAt string (date-time)

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

name string

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

description string

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

labels object

Метки ресурса в формате key:value. Максимум 64 на ресурс.

typeId string

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

zoneId string

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

size string (int64)

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

productIds[] string

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

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

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

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

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

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

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

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

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