Очистка корзины общего диска
Файлы и папки, которые находятся в корзине общего диска, можно окончательно удалить. После удаления ресурса из корзины доступное место на общем диске увеличивается.
Чтобы удалить из корзины отдельный файл, в запросе укажите путь к этому файлу. Если в запросе не указан путь к конкретному ресурсу, корзина общего диска очищается полностью.
Метод могут использовать только администраторы организации.
Для OAuth-приложения необходимо наличие права:
cloud_api:disk.write
Формат запроса
Метод: DELETE.
https://cloud-api.yandex.net/v1/disk/virtual-disks/trash/resources
? [path=<путь к удаляемому ресурсу>]
& [force_async=<признак асинхронного выполнения операции>]
Описание query-параметров
- path
-
Путь к корзине общего диска или удаляемому ресурсу внутри нее.
Указывается в следующем формате:
vd:<vd_hash>:trash:/
— для всей корзины илиvd:<vd_hash>:trash:/<путь внутри корзины общего диска>
— для ресурса внутри корзины, где:<vd_hash>
— метка общего диска. Примерvd_hash
: 9Uyws5pZmXgDNA. Метку общего диска можно получить:- по API — с помощью метода, который возвращает информацию о статусе создания общего диска (посмотреть описание метода);
- в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после
vd/
.
<путь внутри корзины общего диска>
— путь до удаляемого файла или папки в корзине общего диска.
Например, путь до файла test_file.txt, который лежит в папке test_folder общего диска указывается так:
vd:9Uyws5pZmXgDNA:trash:/my_folder/my_file.txt
. - force_async
-
Параметр указывает на возможность асинхронного выполнения операции.
Допустимые значения:
false
— операция не является асинхронной: следующий запрос можно отправлять только тогда, когда выполнен предыдущий.true
— асинхронная операция: следующий запрос можно отправлять, не дожидаясь выполнения предыдущего.
Заголовок
Authorization: OAuth <token>
Формат ответа
Успешный ответ
Очистка Корзины может занять неопределенное время. В зависимости от статуса операции, сервер Яндекс Диска возвращает один из двух вариантов ответа:
-
Если к запрос удалось сразу обработать без ошибок и удаление файлов прошло успешно, API отвечает кодом
204 No Content
. -
Если операция очистки была запущена, но еще не завершилась, Яндекс Диск отвечает кодом
202 Accepted
и возвращает ссылку на запущенную по запросу операцию в теле ответа в объекте Link. Приложения должны самостоятельно следить за статусами таких операций. Посмотреть описание запроса статуса операции.Пример ответа:
{ "href": "https://cloud-api.yandex.net/v1/disk/operations?id=33ca7d03ab21ct41b4a40182e78d828a3f8b72cdb5f4c0e94cc4b1449a63a2fe", "method": "GET", "templated": false }
Элемент
Описание
href
URL. Может быть шаблонизирован, см. ключ
templated
.method
HTTP-метод для запроса URL из ключа
href
.templated
Признак URL, который был шаблонизирован согласно RFC 6570. Возможные значения:
- «true» — URL шаблонизирован: прежде чем отправлять запрос на этот адрес, следует указать нужные значения параметров вместо значений в фигурных скобках.
- «false» — URL может быть запрошен без изменений.
Ответ с ошибкой
Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
Некоторые возможные ошибки:
400
— Некорректные данные.401
— Не авторизован.403
— Пользователь не имеет прав доступа к общему диску.404
— Не удалось найти запрошенный ресурс.406
— Ресурс не может быть представлен в запрошенном формате.423
— Технические работы. Сейчас можно только просматривать и скачивать файлы.429
— Слишком много запросов.503
— Сервис временно недоступен.
Путь к корзине общего диска или удаляемому ресурсу внутри нее.
Указывается в следующем формате: vd:<vd_hash>:trash:/
— для всей корзины или vd:<vd_hash>:trash:/<путь внутри корзины общего диска>
— для ресурса внутри корзины, где:
<vd_hash>
— метка общего диска. Примерvd_hash
: 9Uyws5pZmXgDNA. Метку общего диска можно получить:- по API — с помощью метода, который возвращает информацию о статусе создания общего диска (посмотреть описание метода);
- в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после
vd/
.
<путь внутри корзины общего диска>
— путь до удаляемого файла или папки в корзине общего диска.
Например, путь до файла test_file.txt, который лежит в папке test_folder общего диска указывается так: vd:9Uyws5pZmXgDNA:trash:/my_folder/my_file.txt
.
Параметр указывает на возможность асинхронного выполнения операции.
Допустимые значения:
false
— операция не является асинхронной: следующий запрос можно отправлять только тогда, когда выполнен предыдущий.true
— асинхронная операция: следующий запрос можно отправлять, не дожидаясь выполнения предыдущего.