Удаление файла или папки на общем диске

Метод позволяет удалять файлы и папки по указанному пути на общем диске. По умолчанию ресурс удаляется в корзину общего диска. Файлы и папки хранятся там в течение 30 дней и в течение этого времени продолжают занимать место на общем диске.

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

Чтобы освободить место на общем диске, вы можете удалять ресурсы насовсем:

сразу с общего диска, минуя корзину — для этого укажите в запросе на удаление параметр permanently=true;
непосредственно из корзины общего диска после помещения ресурса туда. Как это сделать

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

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

cloud_api:disk.write

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

Метод: DELETE.

https://cloud-api.yandex.net/v1/disk/virtual-disks/resources
 ? path=<путь к удаляемому ресурсу>
 & [permanently=<признак безвозвратного удаления>]
 & [md5=<MD5-хеш удаляемого файла>]
 & [force_async=<признак асинхронного выполнения операции>]

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

path*

Путь к удаляемому ресурсу на общем диске.

Указывается в следующем формате:

vd:<vd_hash>:disk:/<путь внутри общего диска>

Где

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

Например, путь до файла test_file.txt, который лежит в папке test_folder общего диска указывается так:

vd:9Uyws5pZmXgDNA:disk:/test_folder/test_file.txt

permanently

Признак безвозвратного удаления. Поддерживаемые значения:

false — удаляемый файл или папка перемещаются в Корзину (используется по умолчанию).
true — файл или папка удаляются без помещения в Корзину.

md5

MD5-хеш удаляемого файла. Используется для дополнительной проверки того, что удаляется именно тот файл, который был предназначен для удаления.

MD5-хеш для файла можно получить из ответа на запрос, который возвращает метаинформации о ресурсе.

force_async

Параметр указывает на возможность асинхронного выполнения операции.

Допустимые значения:

false — операция не является асинхронной: следующий запрос можно отправлять только тогда, когда выполнен предыдущий.
true — асинхронная операция: следующий запрос можно отправлять, не дожидаясь выполнения предыдущего.

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

Authorization: OAuth <token>

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

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

Если запрос был обработан без ошибок, API составляет тело ответа в зависимости от вида указанного ресурса — ответ для пустой папки или файла отличается от ответа для непустой папки.

При удалении файла или пустой папки API отвечает кодом 204 No content (ресурс успешно удален) без тела ответа.
Непустая папка может удаляться в течение произвольного времени, поэтому API отвечает кодом 202 Accepted (удаление папки начато) и возвращает ссылку на запущенную по запросу операцию в теле ответа в объекте Link. Приложения должны самостоятельно следить за статусами таких операций. Посмотреть описание запроса статуса операции.

Пример ответа:
```
{
  "href": "https://cloud-api.yandex.net/v1/disk/operations?id=d80c269ce4eb16c0207f0a15t4a31415313452f9e950cd9576f36b1146ee0e42",
  "method": "GET",
  "templated": false
}
```

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

Элемент	Описание
`href`	URL. Может быть шаблонизирован, см. ключ `templated`.
`method`	HTTP-метод для запроса URL из ключа `href`.
`templated`	Признак URL, который был шаблонизирован согласно RFC 6570. Возможные значения: «true» — URL шаблонизирован: прежде чем отправлять запрос на этот адрес, следует указать нужные значения параметров вместо значений в фигурных скобках. «false» — URL может быть запрошен без изменений.

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

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

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

400 — Проверка md5 возможна только для файлов.
401 — Не авторизован.
403 — Недостаточно прав для изменения данных в общей папке.
404 — Не удалось найти запрошенный ресурс.
406 — Ресурс не может быть представлен в запрошенном формате.
423 — Технические работы. Сейчас можно только просматривать и скачивать файлы.
429 — Слишком много запросов.
503 — Сервис временно недоступен.