[ aws . storagegateway ]
list-gateways
Описание
Перечисляет шлюзы, принадлежащие учетной записи Amazon Web Services в указанном в запросе регионе Amazon Web Services. Возвращаемый список упорядочен по имени Amazon Resource Name (ARN) шлюза.
По умолчанию операция возвращает не более 100 шлюзов. Данная операция поддерживает пагинацию, которая позволяет вам по желанию уменьшить количество возвращаемых шлюзов в ответе.
Если у вас больше шлюзов, чем возвращается в ответе (то есть, ответ возвращает только усеченный список ваших шлюзов), ответ содержит маркер, который вы можете указать в последующем запросе, чтобы получить следующую страницу шлюзов.
См. также: Документация API AWS
list-gateways — это операция с пагинацией. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить пагинацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Gateways
Синтаксис
list-gateways
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, значения этих аргументов перепишут значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер, указывающий, с какой точки начать пагинацию. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для вызова AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, возвращающих меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления пагинации предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.
--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.
Для перечисления шлюзов для учетной записи
Следующая list-gateways команда перечисляет все шлюзы, определенные для учетной записи:
aws storagegateway list-gateways
Эта команда выводит блок JSON, содержащий список имен Amazon Resource Name (ARN) шлюзов.
Вывод
Шлюзы -> (список)
Массив объектов GatewayInfo.
(структура)
Описывает объект шлюза.
GatewayId -> (строка)
GatewayARN -> (строка)
GatewayType -> (строка)
Тип шлюза.
Предупреждение
Amazon FSx File Gateway больше недоступен для новых клиентов. Существующие клиенты FSx File Gateway могут продолжить использование сервиса в обычном режиме. Для функций, аналогичных FSx File Gateway, посетите эту запись в блоге .GatewayOperationalState -> (строка)
Состояние шлюза.
Допустимые значения: DISABLED | ACTIVE
GatewayName -> (строка)
Ec2InstanceId -> (строка)
Ec2InstanceRegion -> (строка)
HostEnvironment -> (строка)
Тип аппаратной или программной платформы, на которой работает шлюз.
Примечание
Шлюз для ленточных носителей больше недоступен на устройствах Snow Family.HostEnvironmentId -> (строка)
DeprecationDate -> (строка)
SoftwareVersion -> (строка)
Marker -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|