Расширение x-yc-apigateway-integration:serverless_containers
Расширение x-yc-apigateway-integration:serverless_containers вызывает указанный контейнер и передает в него HTTP-запрос, адресованный к API-шлюзу. В заголовке Host при этом указывается хост, по которому пользователь обратился к API-шлюзу, а не хост контейнера.
Если в запросе есть заголовок X-Forwarded-For, в нем передаются указанные IP-адреса и IP-адрес пользователя, который вызвал контейнер. Иначе — только IP-адрес пользователя, который вызвал контейнер.
Добавить расширение в спецификацию можно с помощью конструктора спецификаций.
Поддерживаемые параметры
В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.
| Параметр | Тип | Описание |
|---|---|---|
container_id |
string |
Идентификатор контейнера. |
service_account_id |
string |
Идентификатор сервисного аккаунта для авторизации при обращении к контейнеру. Сервисный аккаунт необходим для вызова приватного контейнера — для этого он должен иметь роль serverless-containers.containerInvoker или выше на этот контейнер. Если параметр не указан, используется значение верхнеуровневого параметра service_account_id. |
context |
object |
Необязательный параметр. Контекст операции — произвольный объект в формате YAML или JSON. Кодируется в Base64 и передается в контейнер в заголовке X-Yc-ApiGateway-Operation-Context. В context осуществляется подстановка параметров. |
Спецификация расширения
Пример спецификации:
/example/{ID}:
get:
summary: Get ID
operationId: getID
tags:
- example
parameters:
- name: ID
in: path
description: Return ID
required: true
schema:
type: string
x-yc-apigateway-integration:
type: serverless_containers
container_id: b095c95icnvb********
service_account_id: ajehfe12hhl********
Пример проксирования всех запросов в контейнер:
paths:
/{proxy+}:
x-yc-apigateway-any-method:
x-yc-apigateway-integration:
type: serverless_containers
container_id: bba0hocqr8rl********
service_account_id: ajegj8fnpmkm********
parameters:
- explode: false
in: path
name: proxy
required: false
schema:
default: '-'
type: string
style: simple