Создать триггер для почты, который отправляет сообщения в WebSocket-соединения
Создайте триггер для почты, который будет отправлять сообщения в WebSocket-соединения Yandex API Gateway, когда на электронную почту приходит письмо. Адрес электронной почты генерируется сервисом автоматически во время создания триггера.
Перед началом работы
Для создания триггера вам понадобятся:
-
API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу. Если у вас нет API-шлюза, создайте его.
-
Сервисный аккаунт с ролью
api-gateway.websocketBroadcaster
. Если у вас нет сервисного аккаунта, создайте его.
- (Опционально) Бакет, в который будут сохраняться вложения из писем. Если у вас нет бакета, создайте его с ограниченным доступом.
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления
перейдите в каталог, в котором хотите создать триггер. -
Откройте сервис API Gateway.
-
На панели слева выберите
Триггеры. -
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- (Опционально) Введите имя и описание триггера.
- В поле Тип выберите
Почта
. - В поле Запускаемый ресурс выберите
API-шлюз
.
-
(Опционально) В блоке Настройки сохранения вложений:
- В поле Бакет выберите бакет, в который будут сохраняться вложения из писем.
- В поле Сервисный аккаунт укажите сервисный аккаунт, у которого есть права на загрузку объектов в бакет Object Storage.
-
В блоке Настройки группирования сообщений укажите:
- размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
- максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.
Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число сообщений при этом не превышает указанный размер группы.
-
В блоке Настройки API-шлюза:
- В поле API-шлюз выберите API-шлюз.
- В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
- В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:
yc serverless trigger create mail \
--name <имя_триггера> \
--batch-size <размер_группы> \
--batch-cutoff <максимальное_время_ожидания> \
--attachements-bucket <имя_бакета> \
--attachements-service-account-id <идентификатор_сервисного_аккаунта> \
--gateway-id <идентификатор_API-шлюза> \
--gateway-websocket-broadcast-path <путь> \
--gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>
Где:
--name
— имя триггера.
--batch-size
— размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.--batch-cutoff
— максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольшеbatch-cutoff
и отправляет их в WebSocket-соединения. Число сообщений при этом не превышаетbatch-size
.
-
--attachements-bucket
— имя бакета, в который будут сохраняться вложения из писем. Необязательный параметр. -
--attachements-service-account-id
— идентификатор сервисного аккаунта, у которого есть права на загрузку объектов в бакет Object Storage. Необязательный параметр.
--gateway-id
— идентификатор API-шлюза.--gateway-websocket-broadcast-path
— путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.--gateway-websocket-broadcast-account-id
— идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.
Результат:
id: a1sfe084v4h2********
folder_id: b1g88tflruh2********
created_at: "2023-08-04T08:45:31.131391Z"
name: mail-trigger
rule:
mail:
email: a1s8h8avglh2********-cho1****@serverless.yandexcloud.net
batch_settings:
size: "3"
cutoff: 20s
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
status: ACTIVE
Чтобы создать триггер для почты, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.
Yandex API Gateway автоматически сгенерирует адрес электронной почты, при отправке писем на который будет запускаться триггер. Чтобы посмотреть его, получите подробную информацию о триггере.
Проверить результат
Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.