x-yc-apigateway-integration:cloud_ymq extension
Written by
Updated at August 29, 2024
x-yc-apigateway-integration:cloud_ymq gives you access to Yandex Message Queue to handle message queues. Currently, only common queues and the SendMessage operation are supported.
Supported parameters
The table below lists the parameters specific to API Gateway API gateways. You can find the description of other parameters in the OpenAPI 3.0 specification.
| Parameter | Type | Description |
|---|---|---|
action |
string |
Operation in progress. The only possible value is SendMessage. |
queue_url |
string |
Queue address. |
folder_id |
string |
ID of the folder containing the queue. |
delay_seconds |
integer |
This is an optional parameter. It determines the number of seconds to delay the message from being available for processing. |
payload_format_type |
string |
This is an optional parameter. It sets the type of message content. If the value is body, only the request body is written to the queue. If the value is request, the entire request in JSON format is written to the queue. The default value is body. |
service_account_id |
string |
Service account ID. Used for authorization when performing a queue operation. If it is not specified, its value is taken from the parent service_account_id. |
Extension specification
Specification example:
/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********