[ aws . apigateway ]
get-stage
Описание
Получает информацию о ресурсе Stage.
См. также: документацию AWS API
Синтаксис
get-stage
--rest-api-id <value>
--stage-name <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 (строка)
--stage-name (строка)
--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.
Чтобы получить информацию о стадии API
Команда:
aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev
Вывод:
{
"stageName": "dev",
"cacheClusterSize": "0.5",
"cacheClusterEnabled": false,
"cacheClusterStatus": "NOT_AVAILABLE",
"deploymentId": "rbh1fj",
"lastUpdatedDate": 1466802961,
"createdDate": 1460682074,
"methodSettings": {
"*/*": {
"cacheTtlInSeconds": 300,
"loggingLevel": "INFO",
"dataTraceEnabled": false,
"metricsEnabled": true,
"unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
"throttlingRateLimit": 500.0,
"cacheDataEncrypted": false,
"cachingEnabled": false,
"throttlingBurstLimit": 1000,
"requireAuthorizationForCacheControl": true
},
"~1resource/GET": {
"cacheTtlInSeconds": 300,
"loggingLevel": "INFO",
"dataTraceEnabled": false,
"metricsEnabled": true,
"unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
"throttlingRateLimit": 500.0,
"cacheDataEncrypted": false,
"cachingEnabled": false,
"throttlingBurstLimit": 1000,
"requireAuthorizationForCacheControl": true
}
}
}
Вывод
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 -> (структура)
Настройки для развертывания canary на этой стадии.
percentTraffic -> (двойное значение)
deploymentId -> (строка)
stageVariableOverrides -> (массив)
Переменные стадии, переопределённые для развертывания canary, включая новые переменные стадии, введённые в canary. Эти переменные стадии представлены в виде массива строка-строка между именами переменных стадии и их значениями.
key -> (строка)
value -> (строка)
useStageCache -> (логическое значение)
tracingEnabled -> (логическое значение)
webAclArn -> (строка)
tags -> (массив)
Коллекция тегов. Каждый элемент тега связан с определённым ресурсом.
key -> (строка)
value -> (строка)
createdDate -> (метка времени)
lastUpdatedDate -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.