Расширение x-yc-apigateway-integration:cloud_ymq
Статья создана
Обновлена 1 июля 2024 г.
Расширение x-yc-apigateway-integration:cloud_ymq позволяет обращаться к Yandex Message Queue для работы с очередями сообщений. На данный момент поддерживаются только стандартные очереди и операция SendMessage.
Добавить расширение в спецификацию можно с помощью конструктора спецификаций.
Поддерживаемые параметры
В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.
| Параметр | Тип | Описание |
|---|---|---|
action |
string |
Выполняемая операция. Возможные значения: SendMessage. |
queue_url |
string |
Адрес очереди. |
folder_id |
string |
Идентификатор каталога, в котором находится очередь. |
delay_seconds |
integer |
Необязательный параметр. Время в секундах, на которое сообщение будет скрыто после отправки. |
payload_format_type |
string |
Необязательный параметр. Тип содержимого сообщения. Если значение — body, в очередь записывается только тело запроса, если request — весь запрос в формате JSON. Значение по умолчанию — body. |
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/b2g2emj937ux********/dj6000000003********/pets-queue
folder_id: b1gmf8vk4dq********
delay_seconds: 300
service_account_id: ajea046f05rn********