Информация об общем диске

Метод возвращает информацию об общем диске, в том числе количество занятого места.

Метод могут использовать как администраторы, так и другие сотрудники организации. Администратор может получить информацию о любом общем диске организации, другие сотрудники — только о том общем диске, доступ к которому у них есть.

Для OAuth-приложения необходимо наличие одного из прав:

  • cloud_api:disk.info
  • cloud_api:disk.read

Формат запроса

Метод: GET.

https://cloud-api.yandex.net/v1/disk/virtual-disks
 ? vd_hash=<метка общего диска>

Описание query-параметров

vd_hash*
Метка общего диска. Пример vd_hash: 9Uyws5pZmXgDNA. Метку общего диска можно получить:
  • по API — с помощью метода, который возвращает информацию о статусе создания общего диска;
  • в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после vd/.

* Обязательный параметр.

Authorization: OAuth <token>

Формат ответа

Успешный ответ

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает в объекте VirtualDisk ответа информацию об общем диске, в том числе название общего диска, его объем, количество занятого места, объем файлов в его корзине.

Пример ответа:

{
  "total_space": 10737418240,
  "name": "First Group",
  "resource_id": "057583f5-3313-492b-bub5-da428e0c9846",
  "trash_size": 0,
  "vd_hash": "9Uyws5pZmXgDNA",
  "used_space": 138936,
  "permissions": [
    "read"
  ]
}

Описание элементов ответа

VirtualDisk

Элемент

Описание

total_space

Общий объем общего диска, доступный пользователю, в байтах.

name

Наименование общего диска.

resource_id

Идентификатор общего диска в организации.

trash_size

Объем файлов, находящихся в Корзине общего диска, в байтах.

vd_hash

Метка общего диска.

used_space

Количество занятого места на общем диске, в байтах.

permissions

Права доступа к общему диску, которые есть у пользователя, отправляющего запрос:

  • read — чтение данных общего диска;
  • write — запись в любом месте общего диска;
  • delete — удаление общего диска (данное право есть только у администраторов организации).

Ответ с ошибкой

Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

Метка общего диска. Пример vd_hash: 9Uyws5pZmXgDNA. Метку общего диска можно получить:

  • по API — с помощью метода, который возвращает информацию о статусе создания общего диска;
  • в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после vd/.

Обязательный параметр.

Предыдущая
Статус создания общего диска
Следующая
Информация обо всех общих дисках, доступных сотруднику