describe-transit-gateways
Описание
Описывает один или несколько шлюзов транзита. По умолчанию описываются все шлюзы транзита. В качестве альтернативы можно отфильтровать результаты.
См. также: Документацию AWS API
describe-transit-gateways это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе постраничного запроса аргумент --query должен извлечь данные из результатов следующих выражений запроса: TransitGateways
Синтаксис
describe-transit-gateways
[--transit-gateway-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]
Параметры
--transit-gateway-ids (список)
Идентификаторы шлюзов транзита.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Один или несколько фильтров. Возможные значения:
-
options.propagation-default-route-table-id— Идентификатор таблицы маршрутов по умолчанию. -
options.amazon-side-asn— Частный ASN для стороны Amazon в сеансе BGP. -
options.association-default-route-table-id— Идентификатор таблицы маршрутов по умолчанию для ассоциации. -
options.auto-accept-shared-attachments— Указывает, происходит ли автоматическое принятие запросов на подключение (enable|disable). -
options.default-route-table-association— Указывает, автоматически ли ресурсы присоединяются к таблице маршрутов по умолчанию для ассоциации (enable|disable). -
options.default-route-table-propagation— Указывает, автоматически ли ресурсы распространяют маршруты в таблицу маршрутов по умолчанию для распространения (enable|disable). -
options.dns-support— Указывает, включена ли поддержка DNS (enable|disable). -
options.vpn-ecmp-support— Указывает, включена ли поддержка Equal Cost Multipath Protocol (enable|disable). -
owner-id— Идентификатор учётной записи Amazon Web Services, владеющей шлюзом транзита. -
state— Состояние шлюза транзита (available|deleted|deleting|modifying|pending). -
transit-gateway-id— Идентификатор шлюза транзита. -
tag-key— Сочетание ключа/значения тега, назначенного ресурсу. Используйте ключ тега в имени фильтра, а значение тега — в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerдля имени фильтра иTeamAдля значения фильтра.
(структура)
Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут быть использованы для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, фильтры объединяются с помощью AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.
Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве Amazon EC2 User Guide.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью 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
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование конкретного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет параметры конфигурации/окружения.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет параметры конфигурации/окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться без блокировки и тайм-аута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться без блокировки и тайм-аута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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-transit-gateways приводится пример получения подробностей о ваших шлюзах транзита.
aws ec2 describe-transit-gateways
Вывод:
{
"TransitGateways": [
{
"TransitGatewayId": "tgw-0262a0e521EXAMPLE",
"TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE",
"State": "available",
"OwnerId": "111122223333",
"Description": "MyTGW",
"CreationTime": "2019-07-10T14:02:12.000Z",
"Options": {
"AmazonSideAsn": 64516,
"AutoAcceptSharedAttachments": "enable",
"DefaultRouteTableAssociation": "enable",
"AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE",
"DefaultRouteTablePropagation": "enable",
"PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE",
"VpnEcmpSupport": "enable",
"DnsSupport": "enable"
},
"Tags": []
},
{
"TransitGatewayId": "tgw-0fb8421e2dEXAMPLE",
"TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0fb8421e2da853bf3",
"State": "available",
"OwnerId": "111122223333",
"CreationTime": "2019-03-15T22:57:33.000Z",
"Options": {
"AmazonSideAsn": 65412,
"AutoAcceptSharedAttachments": "disable",
"DefaultRouteTableAssociation": "enable",
"AssociationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE",
"DefaultRouteTablePropagation": "enable",
"PropagationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE",
"VpnEcmpSupport": "enable",
"DnsSupport": "enable"
},
"Tags": [
{
"Key": "Name",
"Value": "TGW1"
}
]
}
]
}
Вывод
TransitGateways -> (список)
Информация о транзитных шлюзах.
(структура)
Описание транзитного шлюза.
TransitGatewayId -> (строка)
TransitGatewayArn -> (строка)
State -> (строка)
OwnerId -> (строка)
Description -> (строка)
CreationTime -> (метка времени)
Options -> (структура)
Параметры транзитного шлюза.
AmazonSideAsn -> (длинное целое)
TransitGatewayCidrBlocks -> (список)
CIDR-блоки транзитного шлюза.
(строка)
AutoAcceptSharedAttachments -> (строка)
DefaultRouteTableAssociation -> (строка)
defaultRouteTableAssociation установлено в значение enable, Amazon Web Services Transit Gateway создаст таблицу маршрутов транзитного шлюза по умолчанию.AssociationDefaultRouteTableId -> (строка)
DefaultRouteTablePropagation -> (строка)
defaultRouteTablePropagation установлено в значение enable, Amazon Web Services Transit Gateway создаст таблицу маршрутов транзитного шлюза по умолчанию.PropagationDefaultRouteTableId -> (строка)
VpnEcmpSupport -> (строка)
DnsSupport -> (строка)
SecurityGroupReferencingSupport -> (строка)
Позволяет ссылаться на группу безопасности через VPC, подключенные к транзитному шлюзу, чтобы упростить управление группами безопасности.
Этот параметр по умолчанию отключен.
MulticastSupport -> (строка)
Tags -> (список)
Теги транзитного шлюза.
(структура)
Описание тега.
Key -> (строка)
Ключ тега.
Ограничения: ключи тегов регистрозависимы и допускают максимальную длину 127 символов Юникода. Не может начинаться с aws:.
Value -> (строка)
Значение тега.
Ограничения: значения тегов регистрозависимы и допускают максимальную длину 256 символов Юникода.
NextToken -> (строка)
null, когда больше результатов нет для возврата.
© Copyright 2025, Amazon Web Services. Created using Sphinx.