Spec-Zone.ru › AWS CLI v2

[ aws . appmesh ]

list-gateway-routes

Описание

Возвращает список существующих шлюзовых маршрутов, связанных с виртуальным шлюзом.

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

list-gateway-routes — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: gatewayRoutes

Синтаксис

  list-gateway-routes
--mesh-name <value>
[--mesh-owner <value>]
--virtual-gateway-name <value>
[--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]

Параметры

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

Имя сервисной сетки, в которой нужно перечислить шлюзовые маршруты.

--mesh-owner (строка)

Идентификатор учетной записи Amazon Web Services IAM владельца сервисной сетки. Если это не ваша учетная запись, то это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сетей см. в разделе Работа с совместно используемыми сетками.

--virtual-gateway-name (строка)

Имя виртуального шлюза, в котором нужно перечислить шлюзовые маршруты.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

gatewayRoutes -> (список)

Список существующих шлюзовых маршрутов для указанной сервисной сетки и виртуального шлюза.

(структура)

Объект, представляющий шлюзовый маршрут, возвращаемый операцией перечисления.

arn -> (строка)

Полный Amazon Resource Name (ARN) для шлюзового маршрута.

createdAt -> (временная метка)

Временная метка Unix в секундах для момента создания ресурса.

gatewayRouteName -> (строка)

Имя шлюзового маршрута.

lastUpdatedAt -> (временная метка)

Временная метка Unix в секундах для момента последнего обновления ресурса.

meshName -> (строка)

Имя сервисной сетки, в которой находится ресурс.

meshOwner -> (строка)

Идентификатор учетной записи Amazon Web Services IAM владельца сервисной сетки. Если это не ваша учетная запись, то это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сетей см. в разделе Работа с совместно используемыми сетками.

resourceOwner -> (строка)

Идентификатор учетной записи Amazon Web Services IAM владельца ресурса. Если это не ваша учетная запись, то это идентификатор владельца сети или другой учетной записи, с которой сеть разделена. Дополнительную информацию о совместном использовании сетей см. в разделе Работа с совместно используемыми сетками.

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

Версия ресурса. Ресурсы создаются с версией 1, и эта версия увеличивается каждый раз, когда они обновляются.

virtualGatewayName -> (строка)

Виртуальный шлюз, с которым связан шлюзовый маршрут.

nextToken -> (строка)

Значение nextToken для включения в последующий запрос ListGatewayRoutes. Когда результаты запроса ListGatewayRoutes превышают limit, вы можете использовать это значение для получения следующей страницы результатов. Это значение null, когда больше результатов для возврата нет.

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

Spec-Zone.ru

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