Метод get

HTTP-запрос
Path-параметры
Ответ

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

Чтобы получить список всех доступных API-шлюзов, сделайте list запрос.

HTTP-запрос

GET https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{apiGatewayId}

Path-параметры

Параметр	Описание
apiGatewayId	Обязательное поле. Идентификатор возвращаемого API-шлюза. Чтобы получить идентификатор API-шлюза, сделайте list запрос.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string",
  "domain": "string",
  "logGroupId": "string"
}

Поле	Описание
id	string Идентификатор API-шлюза. Генерируется при создании.
folderId	string Идентификатор каталога, которому принадлежит API-шлюз.
createdAt	string (date-time) Время создания API-шлюза. Строка в формате RFC3339.
name	string Имя API-шлюза. Имя уникально в рамках каталога.
description	string Описание API-шлюза.
labels	object Метки API-шлюза в формате `key:value` .
status	string Состояние API-шлюза. CREATING: API-шлюз создается. ACTIVE: API-шлюз готов к использованию. DELETING: API-шлюз удаляется. ERROR: Сбой API-шлюза. Единственное разрешенное действие c API-шлюзом — удаление.
domain	string Домен по умолчанию для API-шлюза. Генерируется при создании.
logGroupId	string Идентификатор группы журналов выполнения для API-шлюза.