Перейти к содержанию

Управление кэшем

Предзагрузка или удаление файлов из cache, а также полный сброс cache.

Данные операции выполняются асинхронно и в ответе возвращается task_id - идентификатор задачи. При наличии task_id можно проверить статус задачи (описано ниже).

Внимание!

Ограничение на количество запросов к API управления кэшем: не больше 125 обращений в минуту.

Удалить файл

URL: https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://<domain>/path/to/file

В качестве <domain> может использоваться либо выделенный CDN-домен, либо CNAME.

  • Тип запроса: DELETE
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

Параметры строки запроса:

Имя параметра Тип значения Обязательный
cdn_url Текст Да

Возможные коды ответа:

Код ответа Данные ответа Формат ответа Описание
202 task_id: тип string JSON ОК
400 None None Неверный запрос
401 None None Доступ запрещен
503 None None Сервис недоступен

Пример запроса

curl -X DELETE \
-H "CDN-AUTH-TOKEN: $TOKEN" \
'https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://lajjncnn6d.a.trbcdn.net/aloha/cdn/sample_03.flv'

Пример успешного ответа

{
  "task_id": "f0f9601e75b2415db0e2219ea07d8fde"
}

Сбросить весь кэш

URL: https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://<domain>/path/to/file&all

В качестве <domain> может использоваться либо выделенный CDN-домен, либо CNAME.

  • Тип запроса: DELETE
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

Параметры строки запроса:

Имя параметра Тип значения Обязательный
cdn_url Текст Да
all Значение отсутствует Да

Возможные коды ответа:

Код ответа Данные ответа Формат ответа Описание
202 task_id: тип string JSON ОК
400 None None Неверный запрос
401 None None Доступ запрещен
503 None None Сервис недоступен

Пример запроса

curl -X DELETE \
-H "CDN-AUTH-TOKEN: $TOKEN" \
'https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://lajjncnn6d.a.trbcdn.net/aloha/cdn/sample_03.flv&all'

Пример успешного ответа

{
  "task_id": "ccf82df380a34fe7a4992ca810ccfee4"
}

Предзагрузить файл

URL: https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://origin:port/path/to/file

  • Тип запроса: PUT
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

Параметры строки запроса:

Имя параметра Тип значения Обязательный
cdn_url Текст Да

Возможные коды ответа:

Код ответа Данные ответа Формат ответа Описание
202 task_id: тип string JSON ОК
400 None None Неверный запрос
401 None None Доступ запрещен
503 None None Сервис недоступен

Пример запроса

curl -X PUT \
-H "CDN-AUTH-TOKEN: $TOKEN" \
'https://api.cdnvideo.ru/app/cache/v2/objects?cdn_url=http://cache-cdntest.cdnvideo.ru/aloha/cdn/sample_03.flv'

Пример успешного ответа

{
  "task_id": "7a14702e80ec4b99ba5792ca9d781b3d"
}

Проверить статус задачи

URL: https://api.cdnvideo.ru/app/cache/v2/tasks?id=<task_id>

  • Тип запроса: GET
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

Возможные коды ответа:

Код ответа Данные ответа Формат ответа Описание
200 task_description: тип string, status: тип string, date_started: тип string, message: тип string JSON ОК
400 None None Неверный запрос
401 None None Доступ запрещен
404 None None Не найдено
503 None None Сервис недоступен

Пример запроса

curl -X GET \
-H "CDN-AUTH-TOKEN: $TOKEN" \
'https://api.cdnvideo.ru/app/cache/v2/tasks?id=7a14702e80ec4b99ba5792ca9d781b3d'

Пример успешного ответа

{
  "task_description": "PRELOAD http://cache-cdntest.cdnvideo.ru/aloha/cdn/sample_03.flv",
  "status": "completed",
  "date_started": "2018-11-27T09:55:11",
  "message": ""
}