INTEGRITY Документация

Команды API

Cloudflare Waiting Room перенаправляет посетителей в виртуальные залы ожидания, когда они пытаются открыть веб-страницы с высокой посещаемостью.

Cloudflare Waiting Room API предоставляет интерфейс для программного управления Waiting Room.

Формат URL-адреса запроса

Чтобы вызвать Cloudflare Waiting Room API операцию и добавьте эндпойнт к базовому URL-адресу API Cloudflare:

https://api.cloudflare.com/client/v4

Инструкции по аутентификации см. в Начало работы: запросы в документации по API Cloudflare.

Сведения о конечных точках и пагинации см. в Начало работы: конечные точки.

Управление залом ожидания

Операция Метод и URL-путь Примечания
Список залов ожидания GET zones/{:zone_identifier}/waiting_rooms Возвращает список всех залов ожидания в зоне.
Создание зала ожидания POST zones/{:zone_identifier}/waiting_rooms Создайте зал ожидания.
Сведения о зале ожидания GET zones/{:zone_identifier}/waiting_rooms/{:identifier} Получение зала ожидания.
Обновление зала ожидания PUT zones/{:zone_identifier}/waiting_rooms/{:identifier} Обновление зала ожидания.
Удаление зала ожидания DELETE zones/{:zone_identifier}/waiting_rooms/{:identifier} Удалите зал ожидания.
Изменение зала ожидания PATCH zones/{:zone_identifier}/waiting_rooms/{:identifier} Измените настроенный зал ожидания.

Получение текущего статуса зала ожидания

Операция Метод и URL-путь Примечания
Получение текущего статуса зала ожидания GET zones/{:zone_identifier}/waiting_rooms/{:identifier}/status
  • Возвращает queueing если очередь активирована (клиенты помещаются в зал ожидания).
  • Возвращает not_queueing если очередь не активирована или зал ожидания приостановлен.