Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex API Gateway
  • Начало работы
    • Все инструкции
    • Создание API-шлюза
      • Создать таймер
      • Создать триггер для Message Queue
      • Создать триггер для Object Storage
      • Создать триггер для Container Registry
      • Создать триггер для Cloud Logging
        • Устройство
        • Брокер
      • Создать триггер для бюджетов
      • Создать триггер для Data Streams
      • Создать триггер для почты
    • Просмотр операций с ресурсами сервиса
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • История изменений
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • Перед началом работы
  • Создать триггер
  • Проверить результат
  • См. также
  1. Пошаговые инструкции
  2. Создание триггера
  3. Создать триггер для Yandex IoT Core
  4. Устройство

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

Статья создана
Yandex Cloud
Улучшена
mmerihsesh
Обновлена 21 апреля 2025 г.
  • Перед началом работы
  • Создать триггер
  • Проверить результат
  • См. также

Создайте триггер для топика устройства или реестра Yandex IoT Core и отправляйте копии сообщений в WebSocket-соединения.

Важно

Триггер должен находиться в одном облаке с реестром или устройством, из топика которого он читает сообщения.

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

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

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

    Примечание

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

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

  • Реестр или устройство, из топиков которых триггер будет принимать копии сообщений. Если у вас их нет:

    • Создайте реестр.
    • Создайте устройство.

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

Примечание

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

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

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

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

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

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

    • Введите имя и описание триггера.
    • В поле Тип выберите IoT Core (устройство).
    • В поле Запускаемый ресурс выберите API-шлюз.
  6. В блоке Настройки сообщений IoT Core укажите реестр, устройство и MQTT-топик, для которого хотите создать триггер. Если вы создаете триггер для топика реестра, устройство и MQTT-топик можно не указывать. Если MQTT-топик не указан, триггер срабатывает для всех топиков реестра или устройства.

  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 internet-of-things \
  --name <имя_триггера> \
  --registry-id <идентификатор_реестра> \
  --device-id <идентификатор_устройства> \
  --mqtt-topic '$devices/<идентификатор_устройства>/events' \
  --batch-size <размер_группы_сообщений> \
  --batch-cutoff <максимальное_время_ожидания> \
  --gateway-id <идентификатор_API-шлюза> \
  --gateway-websocket-broadcast-path <путь> \
  --gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>

Где:

  • --name — имя триггера.
  • --registry-id — идентификатор реестра.
  • --device-id — идентификатор устройства. Если вы создаете триггер для топика реестра, этот параметр можно не указывать.
  • --mqtt-topic — MQTT-топик, для которого вы хотите создать триггер. Необязательный параметр. Если параметр не указан, триггер срабатывает для всех топиков реестра или устройства.
  • --batch-size — размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.
  • --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольше 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: "2022-10-24T15:19:15.353909857Z"
name: iot-trigger
rule:
  iot_message:
    registry_id: arenou2oj4h2********
    device_id: areqjd6un3h2********
    mqtt_topic: $devices/areqjd6unh2********/events
    batch_settings:
      size: "1"
      cutoff: 0s
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

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

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

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

См. также

  • Триггер для Yandex IoT Core, который передает сообщения из топиков реестров и устройств в функцию Cloud Functions
  • Триггер для Yandex IoT Core, который передает сообщения из топиков реестров и устройств в контейнер Serverless Containers

Была ли статья полезна?

Предыдущая
Создать триггер для Cloud Logging
Следующая
Брокер
Проект Яндекса
© 2025 ООО «Яндекс.Облако»