Подключиться
Yandex API Gateway

ApiGateway

Набор методов управления API-шлюзами.

JSON-представление

{
  "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-шлюза.

Методы

Метод Описание
create Создает API-шлюз в указанном каталоге.
delete Удаляет указанный API-шлюз.
get Возвращает указанный API-шлюз. Обратите внимание, что возвращаются только базовые параметры API-шлюза. Чтобы получить соответствующую спецификацию OpenAPI, сделайте getOpenapiSpec запрос.
getOpenapiSpec Возвращает спецификацию OpenAPI указанного API-шлюза.
list Возвращает список API-шлюзов в указанном каталоге.
listAccessBindings Возвращает список привязок прав доступа для указанного API-шлюза.
listOperations Возвращает список операции для указанного API-шлюза.
setAccessBindings Задает список привязок прав доступа для указанного API-шлюза.
update Изменяет указанный API-шлюз.
updateAccessBindings Обновляет привязки прав доступа для указанного API-шлюза.
В этой статье: