Создать таймер, который отправляет сообщения в WebSocket-соединения
Создайте таймер — триггер, который будет отправлять сообщения в WebSocket-соединения по расписанию.
Перед началом работы
Для создания триггера вам понадобятся:
-
API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу по пути, указанному в настройках триггера. Если у вас нет API-шлюза, создайте его.
Примечание
Триггер не вызывает API-шлюз при отправке сообщений в WebSocket-соединения.
-
Сервисный аккаунт с ролью
api-gateway.websocketBroadcaster. Если у вас нет сервисного аккаунта, создайте его.
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления перейдите в каталог, в котором хотите создать триггер.
-
Откройте сервис API Gateway.
-
На панели слева выберите Триггеры.
-
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- Введите имя и описание триггера.
- В поле Тип выберите
Таймер. - В поле Запускаемый ресурс выберите
API-шлюз.
-
В блоке Настройки таймера:
- В поле Cron-выражение укажите расписание отправки сообщений в WebSocket-соединения в формате cron-выражения.
- (Опционально) В поле Данные укажите сообщение, которое будет передаваться в WebSocket-соединения при срабатывании таймера в поле
payload. Тип данных — строка, длина которой не более 4096 символов.
-
В блоке Настройки API-шлюза:
- В поле API-шлюз выберите API-шлюз.
- В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
- В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:
yc serverless trigger create timer \
--name <имя_таймера> \
--cron-expression '<cron_выражение>' \
--payload <сообщение> \
--gateway-id <идентификатор_API-шлюза> \
--gateway-websocket-broadcast-path <путь> \
--gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>
Где:
--name— имя таймера.--cron-expression— расписание отправки сообщений в WebSocket-соединения в формате cron-выражения.--payload— сообщение, которое будет передаваться в WebSocket-соединения при срабатывании таймера. Длина строки должна быть не более 4096 символов.
--gateway-id— идентификатор API-шлюза.--gateway-websocket-broadcast-path— путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.--gateway-websocket-broadcast-account-id— идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.
Результат:
id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2023-08-04T15:19:15.353909857Z"
name: timer
rule:
timer:
cron_expression: 5 10 ? * * *
payload: <сообщение>
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
status: ACTIVE
Чтобы создать таймер, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.
Проверить результат
Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.