describe-local-gateway-virtual-interface-groups
Описание
Описывает указанные группы виртуальных интерфейсов локальных шлюзов.
См. также: документацию AWS API
describe-local-gateway-virtual-interface-groups является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: LocalGatewayVirtualInterfaceGroups
Синтаксис
describe-local-gateway-virtual-interface-groups
[--local-gateway-virtual-interface-group-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]
Параметры
--local-gateway-virtual-interface-group-ids (список)
Идентификаторы групп виртуальных интерфейсов.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Один или несколько фильтров.
-
local-gateway-id- Идентификатор локального шлюза. -
local-gateway-virtual-interface-group-id- Идентификатор группы виртуальных интерфейсов. -
local-gateway-virtual-interface-id- Идентификатор виртуального интерфейса. -
owner-id- Идентификатор учетной записи Amazon Web Services, владеющей группой виртуальных интерфейсов локального шлюза.
(структура)
Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы укажете несколько фильтров, фильтры объединяются с помощью 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 CLI.
--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.
Чтобы описать группы виртуальных интерфейсов локальных шлюзов
Следующий describe-local-gateway-virtual-interface-groups пример описывает группы виртуальных интерфейсов локальных шлюзов в вашей учетной записи AWS.
aws ec2 describe-local-gateway-virtual-interface-groups
Вывод:
{
"LocalGatewayVirtualInterfaceGroups": [
{
"LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE",
"LocalGatewayVirtualInterfaceIds": [
"lgw-vif-01a23bc4d5EXAMPLE",
"lgw-vif-543ab21012EXAMPLE"
],
"LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE",
"OwnerId": "123456789012",
"Tags": []
}
]
}
Дополнительную информацию см. в разделе Работа с локальными шлюзами в Руководстве пользователя AWS Outposts.
Вывод
LocalGatewayVirtualInterfaceGroups -> (список)
Группы виртуальных интерфейсов.
(структура)
Описание группы виртуальных интерфейсов локального шлюза.
LocalGatewayVirtualInterfaceGroupId -> (строка)
LocalGatewayVirtualInterfaceIds -> (список)
Идентификаторы виртуальных интерфейсов.
(строка)
LocalGatewayId -> (строка)
OwnerId -> (строка)
LocalBgpAsn -> (целое число)
LocalBgpAsnExtended -> (длинное целое число)
LocalGatewayVirtualInterfaceGroupArn -> (строка)
Теги -> (список)
Теги, назначенные группе виртуальных интерфейсов.
(структура)
Описание тега.
Ключ -> (строка)
Ключ тега.
Ограничения: ключи тегов чувствительны к регистру и принимают не более 127 символов Юникода. Не может начинаться с aws:.
Значение -> (строка)
Значение тега.
Ограничения: значения тегов чувствительны к регистру и принимают не более 256 символов Юникода.
ConfigurationState -> (строка)
NextToken -> (строка)
null, когда больше результатов возвращать не нужно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.