x-yc-apigateway-integration:cloud_ymq extension
Written by
Updated at January 31, 2024
x-yc-apigateway-integration:cloud_ymq
gives you access to Yandex Message Queue to handle message queues. Currently, support is only available for standard queues and the SendMessage operation.
Supported parameters
The table below lists the parameters specific to API Gateway API gateways. Read more about other parameters in the OpenAPI Specification 3.0
Parameter | Type | Description |
---|---|---|
action |
string |
Operation in progress. Available values: SendMessage . |
queue_url |
string |
Queue address. |
folder_id |
string |
ID of the folder containing the queue |
delay_seconds |
integer |
This is an optional parameter. The number of seconds to delay the message from being available for processing. |
payload_format_type |
string |
This is an optional parameter. 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 not specified, it defaults to the top-level service_account_id parameter. |
Extension specification
Example specification:
/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********