Spec-Zone.ru › AWS CLI v2

[ aws . backup-gateway ]

получить-шлюз

Описание

Предоставляя ARN (имя ресурса Amazon), этот API возвращает шлюз.

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

Синтаксис

  get-gateway
--gateway-arn <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]

Параметры

--gateway-arn (строка)

Имя ресурса Amazon (ARN) шлюза.

--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.

Вывод

Шлюз -> (структура)

Предоставляя ARN (имя ресурса Amazon), этот API возвращает шлюз.

GatewayArn -> (строка)

Имя ресурса Amazon (ARN) шлюза. Используйте операцию ListGateways, чтобы вернуть список шлюзов для вашей учетной записи и региона Amazon Web Services.

GatewayDisplayName -> (строка)

Имя отображения шлюза.

GatewayType -> (строка)

Тип шлюза.

HypervisorId -> (строка)

Идентификатор гипервизора шлюза.

LastSeenTime -> (метка времени)

Информация о последнем времени связи резервного шлюза с облаком, в формате Unix и UTC.

MaintenanceStartTime -> (структура)

Возвращает время начала еженедельного обслуживания шлюза, включая день и время недели. Обратите внимание, что значения указаны в часовом поясе шлюза. Может быть еженедельным или ежемесячным.

DayOfMonth -> (целое число)

Компонент дня месяца времени начала обслуживания, представленный порядковым номером от 1 до 28, где 1 — первый день месяца, а 28 — последний день месяца.

DayOfWeek -> (целое число)

Порядковый номер от 0 до 6, представляющий день недели, где 0 — воскресенье, а 6 — суббота. День недели указан в часовом поясе шлюза.

HourOfDay -> (целое число)

Компонент часа времени начала обслуживания, представленный как чч, где чч — час (от 0 до 23). Час дня указан в часовом поясе шлюза.

MinuteOfHour -> (целое число)

Компонент минуты времени начала обслуживания, представленный как мм, где мм — минута (от 0 до 59). Минута часа указана в часовом поясе шлюза.

NextUpdateAvailabilityTime -> (метка времени)

Информация о следующем времени доступности обновления шлюза.

VpcEndpoint -> (строка)

Имя домена для виртуального частного облака (VPC)-точек входа, используемых шлюзом для подключения к облаку для резервного шлюза.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API