Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex API Gateway
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Создание API-шлюза
    • Изменение API-шлюза и его спецификации
    • Подключение домена
    • Удаление API-шлюза
    • Просмотр графика мониторинга
    • Просмотр журнала выполнения
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Расширения спецификации
      • Обзор
      • Статический ответ
      • Вызов функции
      • Обращение по HTTP
      • Интеграция с Object Storage
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ApiGatewayService
      • OperationService
    • REST
      • Обзор
      • ApiGateway
        • Обзор
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. ApiGateway
  4. list

Метод list

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

Возвращает список API-шлюзов в указанном каталоге.

HTTP-запрос

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

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка API-шлюзов. Чтобы получить идентификатор каталога, используйте запрос list.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов.
filter Выражение фильтра, для фильтрации списка функций в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю ApiGateway.name. 2. Условный оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. Пример фильтра: name=my-apigw.

Ответ

HTTP Code: 200 - OK

{
  "apiGateways": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "domain": "string",
      "logGroupId": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
apiGateways[] object

Возвращает список API-шлюзов в указанном каталоге.

apiGateways[].
id
string

Идентификатор API-шлюза. Генерируется при создании.

apiGateways[].
folderId
string

Идентификатор каталога, которому принадлежит API-шлюз.

apiGateways[].
createdAt
string (date-time)

Время создания API-шлюза.

Строка в формате RFC3339.

apiGateways[].
name
string

Имя API-шлюза. Имя уникально в рамках каталога.

apiGateways[].
description
string

Описание API-шлюза.

apiGateways[].
labels
object

Метки API-шлюза в формате key:value .

apiGateways[].
status
string

Состояние API-шлюза.

  • CREATING: API-шлюз создается.
  • ACTIVE: API-шлюз готов к использованию.
  • DELETING: API-шлюз удаляется.
  • ERROR: Сбой API-шлюза. Единственное разрешенное действие c API-шлюзом — удаление.
apiGateways[].
domain
string

Домен по умолчанию для API-шлюза. Генерируется при создании.

apiGateways[].
logGroupId
string

Идентификатор группы журналов выполнения для API-шлюза.

nextPageToken string

Токен для получения следующей страницы списка. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов.

Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»