Информация обо всех общих дисках, доступных сотруднику

Метод возвращает список всех общих дисков указанной организации, к которым есть доступ у сотрудника — владелеца OAuth-токена, отправляемого в заголовке запроса. В списке содержатся названия, идентификаторы, метки общих дисков и другая информация о них.

Метод могут использовать сотрудники организации.

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

cloud_api:disk.info
cloud_api:disk.read

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/virtual-disks/discovery
 ? org_id=<идентификатор организации>
 & [limit=<ограничение на количество возвращаемых ресурсов>]
 & [offset=<смещение относительно начала списка>]

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

org_id*

Идентификатор организации в Яндекс 360 для бизнеса.

Чтобы посмотреть идентификатор в интерфейсе, откройте кабинет организации и выберите Общие настройки → Профиль организации. Идентификатор будет указан под названием организации.

limit

Количество объектов с описанием общих дисков, которое следует вернуть в ответе (используется для постраничного вывода).

Значение по умолчанию — 10. Минимальное значение — 1. Максимальное значение — 100.

offset

Количество объектов с описанием общих дисков, которые следует опустить в ответе (используется для постраничного вывода).

Допустим, сотруднику доступны три общих диска. Если запросить их список с параметром offset=1, API Диска вернет только описания второго и третьего общего диска.

Значение по умолчанию — 0.

Authorization: OAuth <token>

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

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

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

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

{
  "items": [
    {
      "total_space": 10737418240,
      "name": "First Group",
      "resource_id": "057583f5-3313-492b-bub5-da428e0c9846",
      "trash_size": 0,
      "vd_hash": "9Uyws5pZmXgDNA",
      "used_space": 138936,
      "permissions": [
        "read"
      ]
    },
    {
      "total_space": 10737418240,
      "name": "Second Group",
      "resource_id": "458053f5-8562-4782b-bbb5-fa758e0a3975",
      "trash_size": 0,
      "vd_hash": "8Uyys9pZnXgNAD",
      "used_space": 82667,
      "permissions": [
        "write",
        "read"
      ]
    }
  ],
  "total": 2,
  "limit": 10,
  "offset": 0
}

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

VirtualDiskList

Элемент	Описание
`items`	Массив общих дисков организации VirtualDisk.
`total`	Общее количество общих дисков, доступных пользователю.
`limit`	Максимальное количество элементов в массиве `items`, заданное в запросе.
`offset`	Смещение начала выборки от первого элемента в списке всех общих дисков.

VirtualDisk

Элемент	Описание
`total_space`	Общий объем общего диска, доступный пользователю, в байтах.
`name`	Наименование общего диска.
`resource_id`	Идентификатор общего диска в организации.
`trash_size`	Объем файлов, находящихся в Корзине общего диска, в байтах.
`vd_hash`	Метка общего диска.
`used_space`	Количество занятого места на общем диске, в байтах.
`permissions`	Права доступа к общему диску, которые есть у пользователя, отправляющего запрос: `read` — чтение данных общего диска; `write` — запись в любом месте общего диска; `delete` — удаление общего диска (данное право есть только у администраторов организации).

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

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

Была ли статья полезна?

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

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