Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-route-servers

Описание

Описывает один или несколько маршрутизаторов путей.

Amazon VPC Route Server упрощает маршрутизацию трафика между рабочими нагрузками, развернутыми в VPC и его интернет-шлюзах. С помощью этой функции VPC Route Server динамически обновляет таблицы маршрутов VPC и интернет-шлюзов вашими предпочтительными маршрутами IPv4 или IPv6 для достижения отказоустойчивости маршрутизации для этих рабочих нагрузок. Это позволяет вам автоматически перенаправлять трафик внутри VPC, что повышает управляемость маршрутизации VPC и взаимодействие с рабочими нагрузками третьих сторон.

Маршрутизатор путей поддерживает следующие типы таблиц маршрутов:

  • Таблицы маршрутов VPC, не связанные с подсетями
  • Таблицы маршрутов подсетей
  • Таблицы маршрутов интернет-шлюзов

Маршрутизатор путей не поддерживает таблицы маршрутов, связанные с виртуальными частными шлюзами. Для распространения маршрутов в таблицу маршрутов шлюза транзита используйте Transit Gateway Connect.

Дополнительную информацию см. в разделе Динамическая маршрутизация в вашей VPC с помощью VPC Route Server в Руководстве пользователя Amazon VPC.

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

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

Синтаксис

  describe-route-servers
[--route-server-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--route-server-ids (список)

Идентификаторы маршрутизаторов путей, которые нужно описать.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров для применения к запросу описания.

(структура)

Пара имя-значение фильтра, используемая для возвращения более конкретного списка результатов из операции описания. Фильтры могут использоваться для соответствия набору ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, фильтры соединяются с помощью AND , и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR , и запрос возвращает все результаты, соответствующие любому из указанных значений.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (логическое значение)

Проверка наличия необходимых разрешений для действия без фактического выполнения запроса и предоставление ответа об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке является DryRunOperation . В противном случае это UnauthorizedOperation .

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода командной строки.

Вывод

RouteServers -> (список)

Информация о описанных серверах маршрутизации.

(структура)

Описывает сервер маршрутизации и его конфигурацию.

Сервер маршрутизации Amazon VPC упрощает маршрутизацию трафика между рабочими нагрузками, развернутыми внутри VPC и его интернет-шлюзами. С помощью этой функции сервер маршрутизации VPC динамически обновляет таблицы маршрутизации VPC и интернет-шлюза с вашими предпочтительными маршрутами IPv4 или IPv6, чтобы обеспечить отказоустойчивость маршрутизации для этих рабочих нагрузок. Это позволяет вам автоматически перенаправлять трафик внутри VPC, что повышает управляемость маршрутизации VPC и межотраслевую совместимость с рабочими нагрузками третьих сторон.

Сервер маршрутизации поддерживает следующие типы таблиц маршрутизации:

  • Таблицы маршрутизации VPC, не связанные с подсетями
  • Таблицы маршрутизации подсетей
  • Таблицы маршрутизации интернет-шлюзов

Сервер маршрутизации не поддерживает таблицы маршрутизации, связанные с виртуальными частными шлюзами. Для распространения маршрутов в таблицу маршрутизации шлюза транзита используйте Transit Gateway Connect.

RouteServerId -> (строка)

Уникальный идентификатор сервера маршрутизации.

AmazonSideAsn -> (целое)

Автономный номер системы (ASN) Border Gateway Protocol (BGP) для устройства. Допустимые значения находятся в диапазоне от 1 до 4294967295. Рекомендуется использовать частный ASN в диапазоне 64512–65534 (16-битный ASN) или 4200000000–4294967294 (32-битный ASN).

State -> (строка)

Текущее состояние сервера маршрутизации.

Tags -> (список)

Любые теги, назначенные серверу маршрутизации.

(структура)

Описывает тег.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают не более 127 символов Юникода. Не должно начинаться с aws: .

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают не более 256 символов Юникода.

PersistRoutesState -> (строка)

Текущее состояние сохранения маршрутов для сервера маршрутизации.

PersistRoutesDuration -> (целое)

Количество минут, в течение которого сервер маршрутизации будет ожидать после повторного установления BGP, чтобы не сохранять маршруты в FIB и RIB. Значение должно быть в диапазоне от 1 до 5. Значение по умолчанию равно 1. Действительно только если persistRoutesState имеет значение «enabled».

Если вы установите длительность в 1 минуту, то когда ваше сетевое устройство повторно установит BGP с сервером маршрутизации, у него есть 1 минута, чтобы повторно узнать свою смежную сеть и рекламировать эти маршруты серверу маршрутизации, прежде чем сервер маршрутизации возобновит обычную работу. В большинстве случаев 1 минута, вероятно, будет достаточно. Однако, если у вас есть опасения, что ваша BGP-сеть может не быть способна полностью повторно установить и повторно изучить все за 1 минуту, вы можете увеличить длительность до 5 минут.

SnsNotificationsEnabled -> (булево)

Указывает, включены ли уведомления SNS для сервера маршрутизации. Включение уведомлений SNS сохраняет изменения статуса BGP в теме SNS, предоставленной Amazon Web Services.

SnsTopicArn -> (строка)

ARN темы SNS, в которую публикуются уведомления.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение равно null, когда больше результатов нет.

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

Spec-Zone.ru

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