get-export

Описание

Экспортирует развернутую версию RestApi в указанном формате.

См. также: Документацию API AWS

Синтаксис

  get-export
--rest-api-id <value>
--stage-name <value>
--export-type <value>
[--parameters <value>]
[--accepts <value>]
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--rest-api-id (строка)

Идентификатор связанного RestApi.

--stage-name (строка)

Имя стадии (Stage), которая будет экспортирована.

--export-type (строка)

Тип экспорта. Допустимые значения: ‘oas30’ для OpenAPI 3.0.x и ‘swagger’ для Swagger/OpenAPI 2.0.

--parameters (словарь)

Словарь пар «ключ-значение» параметров строки запроса, определяющих свойства экспорта в зависимости от запрошенного exportType . Для exportType oas30 и swagger поддерживается любая комбинация следующих параметров: extensions='integrations' или extensions='apigateway' будут экспортировать API с расширениями x-amazon-apigateway-integration. extensions='authorizers' будут экспортировать API с расширениями x-amazon-apigateway-authorizer. postman будут экспортировать API с расширениями Postman, позволяющими импорт в инструмент Postman

ключ -> (строка)

значение -> (строка)

Краткая форма записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--accepts (строка)

Тип содержимого экспорта, например application/json . В настоящее время поддерживаются application/json и application/yaml для exportType типа ``oas30`` и swagger . Это должно быть указано в заголовке Accept для прямых запросов к API.

outfile (строка) Имя файла, в который будет сохранено содержимое

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить вывод в цвете.

включено
выключено
автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка в кодировке base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Получение JSON-шаблона Swagger для стадии

Команда:

aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

Получение JSON-шаблона Swagger + расширений API Gateway для стадии

Команда:

aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

Получение JSON-шаблона Swagger + расширений Postman для стадии

Команда:

aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

Вывод

contentType -> (строка)

Значение заголовка типа содержимого в ответе HTTP. Соответствует допустимому типу «accept» в запросе.

contentDisposition -> (строка)

Значение заголовка content-disposition в ответе HTTP.

body -> (двоичные данные)

Двоичные данные ответа GetExport, содержащие экспорт.