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

Метод создает общий диск в вашей организации. В ответе возвращается идентификатор нового общего диска.

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

Важно

Создавать общие диски можно только после оплаты лимита на их создание. Как купить лимит, описано в Справке по тарифам и оплате Яндекс 360 для бизнеса.

Создание общего диска может занимать некоторое время. Дождитесь успешного ответа на запрос о статусе этого процесса. Так вы получите метку общего диска. Только после этого можно предоставлять права доступа к нему.

Необходимые права доступа для OAuth-приложения:

  • cloud_api:disk.read
  • cloud_api:disk.write

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

Метод: POST.

https://cloud-api.yandex.net/v1/disk/virtual-disks
 ? org_id=<идентификатор организации>

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

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

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

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

Authorization: OAuth <token>
Content-Type: application/json

Тело запроса

{
  "name": "Общий_диск 1",
  "description": "Описание общего_диска 1"
}

Параметр

Тип данных

Описание

name*

string

Название общего диска. Минимальная длина — 2, максимальная длина — 255.

description*

string

Описание общего диска. Максимальная длина — 512.

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

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

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

Важно

Сохраните полученный идентификатор. Без него вы не сможете отправить запрос на получение статуса создания общего диска и дальше работать с созданным общим диском через API.

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

{
  "resource_id": "440050dc-178a-4ae2-beca-ae0567e4b0bf"
}

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

VirtualDiskResourceID

Элемент

Описание

resource_id

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

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

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

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

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

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