Статус создания общего диска

Метод возвращает информацию о статусе создания общего диска. Если создание завершилось успешно, ответ будет также содержать метку общего диска. Метка нужна для отправки других API-запросов по общим дискам.

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

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

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

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/virtual-disks/manage/org-resources
 ? org_id=<идентификатор организации>
 & resource_id=<идентификатор общего диска в организации>

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

org_id*

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

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

resource_id*

Идентификатор общего диска в организации. Пример resource_id: 057583f5-3313-492b-bub5-da428e0c9846. Идентификатор приходит в ответе на запрос о создании общего диска.

Если вы не сохранили идентификатор при создании общего диска, то можете получить его только в интерфейсе кабинета организации Яндекс 360 для бизнеса: перейдите в раздел ДискОбщие диски — идентификатор указан в колонке ID напротив названия диска.

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

Authorization: OAuth <token>

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

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

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

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

{
  "vd_hash": "9Uyws5pZmXgDNA",
  "resource_id": "057583f5-3313-492b-bub5-da428e0c9846",
  "description": "Описание общего_диска 1",
  "name": "Общий_диск 1",
  "state": "created"
}

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

VirtualDiskCreateState

Элемент

Описание

vd_hash

Метка общего диска. Является уникальной и идентифицирует конкретный общий диск в Яндекс Диске.

Значение vd_hash является действительным, только если в параметре state вернулось значение created.

resource_id

Идентификатор общего диска в организации, который направлялся в запросе. Идентифицирует конкретный общий диск в кабинете организации Яндекс 360 для бизнеса.

description

Описание общего диска.

name

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

state

Статус создания общего диска:

  • initialize — процесс создания общего диска не окончен;
  • created — общий диск создан.

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

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

Некоторые возможные ошибки:

  • 403 — Доступ к ресурсу запрещен.
  • 404 — Ресурс не найден.

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

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

Идентификатор общего диска в организации. Пример resource_id: 057583f5-3313-492b-bub5-da428e0c9846. Идентификатор приходит в ответе на запрос о создании общего диска.

Если вы не сохранили идентификатор при создании общего диска, то можете получить его только в интерфейсе кабинета организации Яндекс 360 для бизнеса: перейдите в раздел ДискОбщие диски — идентификатор указан в колонке ID напротив названия диска.

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