← Cloudflare Waiting Room / waiting-room / additional-options

Создание запланированных событий

Если нужно изменить поведение зала ожидания на определённый период времени, например метод очереди или количество активных пользователей, настройте запланированное событие. Сделать это можно в панели управления или через API.

Любые свойства, заданные для события, на время его действия переопределяют свойства по умолчанию, заданные для зала ожидания.

1. В своём приложении перейдите к Трафик > Waiting Room.

2. Разверните зал ожидания и выберите Планирование события.

3. Настройте параметры события: укажите его название, добавьте описание (необязательно) и выберите дату и время начала и окончания.

4. Вы также можете включить предварительную очередь: в этом случае нужно задать время предварительной очереди. Также можно выбрать Перемешивание при начале события и все пользователи из предварительной очереди будут допущены в случайном порядке при начале события.

5. Выберите Далее.

6. В Настройки разделе вы можете задать новые значения для Total active users, New users per minute, Session duration, Session Renewal и Queueing Method. Для каждого из этих параметров также есть возможность всегда наследовать значения, заданные в вашем Waiting Room. При включении этой опции изменение настроек базового Waiting Room автоматически обновит соответствующий параметр Event.

7. Выберите Далее.

8. В разделе настройки внешнего вида можно выбрать вариант Always inherit your waiting room’s template (по умолчанию) либо переопределить его с помощью Custom Event Template. В этом случае нужно импортировать свой собственный шаблон. Перед тем как продолжить, обязательно просмотрите результат в предпросмотре.

9. Выберите Далее и проверьте детали и настройки своего события.

10. Выберите Save.

На странице вашего зала ожидания, в столбце Следующее событие столбце можно увидеть дату следующего запланированного события. В этом столбце будет указано N/A на случай, если для этого зала ожидания не запланировано событие. Вы всегда можете приостановить, изменить или удалить своё событие.

Чтобы создать событие, выполните Запрос POST включая обязательные и необязательные параметры. Любые свойства, заданные для события, на время его действия переопределяют свойства зала ожидания по умолчанию.

Если вы используете пользовательский шаблон, вам может понадобиться добавить соответствующие переменные в ваш шаблон (перечислены в разделе json_response_enabled параметр).

Хотя большинство параметров совпадают с параметрами обычного зала ожидания, при создании события есть несколько уникальных настроек. Полный список настроек события приведён в Создание события.

• name (обязательно): уникальное имя из букв, цифр, дефисов и символов подчёркивания.
• event_start_time (обязательно): временная метка в формате ISO 8601, обозначающая начало события. С этого момента пользователи из очереди обрабатываются согласно настройкам события. Должна наступать не менее чем за 1 минуту до event_end_time.
• event_end_time (обязательно): временная метка в формате ISO 8601, обозначающая окончание события.
• shuffle_at_event_start: Если true и prequeue_start_time не равно null, пользователи в предварительной очереди будут случайным образом перемешаны в event_start_time. Обычно используется для обеспечения справедливости, если в вашем событии применяется FIFO метод очереди.
• prequeue_start_time: временная метка в формате ISO 8601, которая указывает, когда начинается постановка всех пользователей в очередь до начала события. Должна наступать не менее чем за за 5 минут до event_start_time.
• description: текстовое описание с более подробной информацией о событии.
• suspended: Если true, событие игнорируется, и трафик обрабатывается согласно обычной конфигурации зала ожидания.

При настройке событий может также потребоваться изменить метод очереди зала ожидания, используемый по умолчанию.

Установите для зала ожидания метод очереди Сквозная передача если вы хотите обычно пропускать трафик, но ограничивать его во время запланированного события.

Установите для зала ожидания метод очереди Reject если вы хотите обычно блокировать весь трафик, но разрешать его во время особых событий, например регистрации или продажи билетов.

Настройте систему «лотереи», чтобы вознаградить всех пользователей, вставших в очередь до начала вашего события.

Пользователи, которые попадают в ваше приложение в течение периода предварительной очереди являются назначается в случайном порядке место в очереди при начале события. Если событие использует Очерёдность FIFO, пользователи, которые попадают в ваше приложение, после периода предварительной очереди получают места в очереди после пользователей из предварительной очереди.

Чтобы настроить «лотерею», добавьте следующие параметры в вашем запросе к API:

• prequeue_start_time
• shuffle_at_event_start

Поскольку некоторые свойства, заданные для события, на время его действия переопределяют свойства зала ожидания по умолчанию, рекомендуется использовать API, чтобы предварительный просмотр конфигурации события до его начала.

Эта команда показывает конфигурацию события так, как если бы оно было активным: поля, унаследованные от зала ожидания, будут отображать свои текущие значения.

Чтобы изменить событие, используйте Запрос PATCH.

Вы можете отключить событие, задав его suspended параметр в true.

Кроме того, события не станут активными, если сам зал ожидания Отключено.

Выполните эти действия, если хотите развернуть страницу планового технического обслуживания без очереди до или после окна обслуживания.

1. Создание зала ожидания с Сквозная передача метод очереди включён.
2. Создайте событие зала ожидания для этого зала с помощью Reject метод очереди включён.

После завершения запланированного события пользователи получат доступ к вашему сайту. Вы можете завершить период технического обслуживания до окончания запланированного события, установив для события значение disabled.