[ aws . apigateway ]
получить-этапы
Описание
Получает информацию об одном или нескольких ресурсах Stage.
См. также: Документация AWS API
Синтаксис
get-stages
--rest-api-id <value>
[--deployment-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--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 (строка)
--deployment-id (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос к API. Если предоставлено без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладку логов.
--endpoint-url (строка)
Переопределить стандартный URL команды на заданный URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--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.
Чтобы получить список этапов для REST API
Команда:
aws apigateway get-stages --rest-api-id 1234123412
Вывод:
{
"item": [
{
"stageName": "dev",
"cacheClusterSize": "0.5",
"cacheClusterEnabled": true,
"cacheClusterStatus": "AVAILABLE",
"deploymentId": "123h64",
"lastUpdatedDate": 1456185138,
"createdDate": 1453589092,
"methodSettings": {
"~1resource~1subresource/POST": {
"cacheTtlInSeconds": 300,
"loggingLevel": "INFO",
"dataTraceEnabled": true,
"metricsEnabled": true,
"throttlingRateLimit": 500.0,
"cacheDataEncrypted": false,
"cachingEnabled": false,
"throttlingBurstLimit": 1000
}
}
}
]
}
Вывод
элемент -> (список)
Текущая страница элементов из этого набора.
(структура)
Представляет собой уникальный идентификатор версии развернутого RestApi, который доступен для пользователей.
deploymentId -> (строка)
clientCertificateId -> (строка)
stageName -> (строка)
description -> (строка)
cacheClusterEnabled -> (булево)
CachingEnabled в true для метода.cacheClusterSize -> (строка)
cacheClusterStatus -> (строка)
methodSettings -> (массив)
Массив, определяющий параметры метода для ресурса Stage. Ключи (обозначенные как /{method_setting_key ниже) — пути методов, определённые как {resource_path}/{http_method} для отдельной переопределённой команды, или /\*/\* для переопределения всех методов на этапе.
key -> (строка)
value -> (структура)
Определяет свойства параметров метода.
metricsEnabled -> (булево)
loggingLevel -> (строка)
OFF, ERROR и INFO. Выберите ERROR, чтобы записывать в CloudWatch Logs только записи уровня ошибки, или выберите INFO, чтобы включить все события ERROR, а также дополнительные информационные события.dataTraceEnabled -> (булево)
throttlingBurstLimit -> (целое число)
throttlingRateLimit -> (двойное число)
cachingEnabled -> (булево)
cacheTtlInSeconds -> (целое число)
cacheDataEncrypted -> (булево)
requireAuthorizationForCacheControl -> (булево)
unauthorizedCacheControlHeaderStrategy -> (строка)
variables -> (массив)
Массив, определяющий переменные этапа для ресурса Stage. Имена переменных могут содержать буквенно-цифровые символы и символ подчеркивания, а значения должны соответствовать [A-Za-z0-9-._~:/?#&=,]+.
key -> (строка)
value -> (строка)
documentationVersion -> (строка)
accessLogSettings -> (структура)
Параметры ведения журнала доступа на данном этапе.
format -> (строка)
$context.requestId.destinationArn -> (строка)
amazon-apigateway-.canarySettings -> (структура)
Настройки развертывания канонического метода на данном этапе.
percentTraffic -> (двойное число)
deploymentId -> (строка)
stageVariableOverrides -> (массив)
Переменные этапа, переопределённые для развертывания канонического релиза, включая новые переменные этапа, введенные в каноническом методе. Эти переменные этапа представлены в виде массива имя-значение переменных этапа.
key -> (строка)
value -> (строка)
useStageCache -> (булево)
tracingEnabled -> (булево)
webAclArn -> (строка)
tags -> (массив)
Коллекция тегов. Каждый элемент тега связан с заданным ресурсом.
key -> (строка)
value -> (строка)
createdDate -> (временная метка)
lastUpdatedDate -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.