Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex API Gateway
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Создание API-шлюза
    • Изменение API-шлюза и его спецификации
    • Подключение домена
    • Удаление API-шлюза
    • Мониторинг
    • Просмотр журнала выполнения
  • Практические руководства
    • Развертывание веб-приложения
    • Разработка навыка Алисы и сайта с авторизацией
    • Разработка Slack-бота
    • Разработка Telegram-бота
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Расширения спецификации
      • Обзор
      • Статический ответ
      • Вызов функции
      • Интеграция с Serverless Containers
      • Обращение по HTTP
      • Интеграция с Object Storage
      • Интеграция с DataSphere
      • Интеграция с Data Streams
      • Интеграция с Message Queue
      • Жадные параметры
      • Обобщенный HTTP-метод
      • Авторизация с помощью функции
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • ApiGatewayService
      • OperationService
    • REST (англ.)
      • Overview
      • ApiGateway
        • Overview
        • addDomain
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • removeDomain
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Концепции
  2. Расширения спецификации
  3. Интеграция с Message Queue

Расширение x-yc-apigateway-integration:cloud_ymq

Статья создана
Yandex Cloud
  • Поддерживаемые параметры
  • Спецификация расширения

Расширение x-yc-apigateway-integration:cloud_ymq позволяет обращаться к Yandex Message Queue для работы с очередями сообщений. На данный момент поддерживаются только стандартные очереди и операция SendMessage. При выполнении этой операции в очередь записывается содержимое тела запроса, который пришел в API Gateway.

Поддерживаемые параметры

В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.

Параметр Тип Описание
action string Тип операции, которая будет выполняться. Возможные значения: SendMessage.
queue_url string Адрес очереди.
folder_id string Идентификатор каталога, в котором находится очередь.
delay_seconds integer Время в секундах, на которое сообщение будет скрыто после отправки.
service_account_id string Идентификатор сервисного аккаунта. Используется для авторизации при выполнении операции с очередью. Если параметр не указан, используется значение верхнеуровнего параметра service_account_id.

Спецификация расширения

Пример спецификации:

  /pets-queue:
    post:
      x-yc-apigateway-integration:
        type: cloud_ymq
        action: SendMessage
        queue_url: https://message-queue.api.cloud.yandex.net/b2g2emj937uxo97w65lt/dj6000000003lln607ma/pets-queue
        folder_id: b1gmf8vk4dq3paduc4gj
        delay_seconds: 300
        service_account_id: ajea046f05rndh38bfie

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

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Поддерживаемые параметры
  • Спецификация расширения