Связаться с намиПодключиться

Создать триггер для Object Storage, который отправляет сообщения в WebSocket-соединения

Статья создана
Улучшена
Обновлена 21 апреля 2025 г.

Создайте триггер для Object Storage, который будет отправлять сообщения в WebSocket-соединения при создании, перемещении или удалении объекта в бакете.

Перед началом работы

Для создания триггера вам понадобятся:

  • API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу по пути, указанному в настройках триггера. Если у вас нет API-шлюза, создайте его.

    Примечание

    Триггер не вызывает API-шлюз при отправке сообщений в WebSocket-соединения.

  • Сервисный аккаунт с ролью api-gateway.websocketBroadcaster. Если у вас нет сервисного аккаунта, создайте его.

  • Бакет, при событиях с объектами в котором триггер будет запускаться. Если у вас нет бакета, создайте его с ограниченным доступом.

Создать триггер

Примечание

Триггер начинает работать в течение 5 минут после создания.

  1. В консоли управления перейдите в каталог, в котором хотите создать триггер.

  2. Откройте сервис API Gateway.

  3. На панели слева выберите Триггеры.

  4. Нажмите кнопку Создать триггер.

  5. В блоке Базовые параметры:

    • Введите имя и описание триггера.
    • В поле Тип выберите Object Storage.
    • В поле Запускаемый ресурс выберите API-шлюз.

  6. В блоке Настройки Object Storage:

    • В поле Бакет выберите бакет, для событий с объектами которого хотите создать триггер.
    • В поле Типы событий выберите события, после наступления которых триггер будет запускаться.
    • (Опционально) В поле Префикс ключа объекта введите префикс для фильтрации.
    • (Опционально) В поле Суффикс ключа объекта введите суффикс для фильтрации.

  7. В блоке Настройки группирования сообщений укажите:

    • размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
    • максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.

    Триггер группирует события не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число событий при этом не превышает указанный размер группы.

  8. В блоке Настройки API-шлюза:

    • В поле API-шлюз выберите API-шлюз.
    • В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
    • В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.

  9. Нажмите кнопку Создать триггер.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:

  yc serverless trigger create object-storage \
    --name <имя_триггера> \
    --bucket-id <идентификатор_бакета> \
    --prefix '<префикс_ключа_объекта>' \
    --suffix '<суффикс_ключа_объекта>' \
    --events 'create-object','delete-object','update-object' \
    --batch-size <размер_группы> \
    --batch-cutoff <максимальное_время_ожидания> \
    --gateway-id <идентификатор_API-шлюза> \
    --gateway-websocket-broadcast-path <путь> \
    --gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>

Где:

  • --name — имя триггера.
  • --bucket-id — идентификатор бакета.
  • --prefix — префикс ключа объекта в бакете. Необязательный параметр. Используется для фильтрации.
  • --suffix — суффикс ключа объекта в бакете. Необязательный параметр. Используется для фильтрации.
  • --events — события, после наступления которых триггер запускается.
  • --batch-size — размер группы событий. Необязательный параметр. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
  • --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда. Триггер группирует события не дольше batch-cutoff и отправляет их в WebSocket-соединения. Число событий при этом не превышает batch-size.
  • --gateway-id — идентификатор API-шлюза.
  • --gateway-websocket-broadcast-path — путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
  • --gateway-websocket-broadcast-account-id — идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.

Результат:

id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2023-08-24T15:19:15.353909857Z"
name: os-trigger
rule:
  object_storage:
    event_type:
    - OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
    - OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT
    - OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
    bucket_id: s3-for-trigger
    prefix: dev
    suffix: 12.jpg
    batch_settings:
      size: "3"
      cutoff: 20s
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

Чтобы создать триггер для Object Storage, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.

Проверить результат

Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.

См. также

Предыдущая
Создать триггер для Message Queue
Следующая
Создать триггер для Container Registry