Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

Поиск групп транзитных шлюзов для мультикаста

Описание

Ищет одну или несколько групп мультикаста транзитного шлюза и возвращает информацию о членстве в группе.

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

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

Синтаксис

  search-transit-gateway-multicast-groups
--transit-gateway-multicast-domain-id <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-multicast-domain-id (строка)

Идентификатор домена мультикаста транзитного шлюза.

--filters (список)

Один или несколько фильтров. Возможные значения:

  • group-ip-address — IP-адрес группы мультикаста транзитного шлюза.
  • is-group-member — ресурс является членом группы. Допустимые значения: true | false.
  • is-group-source — ресурс является источником группы. Допустимые значения: true | false.
  • member-type — тип члена. Допустимые значения: igmp | static.
  • resource-id — Идентификатор ресурса.
  • resource-type — тип ресурса. Допустимые значения: vpc | vpn | direct-connect-gateway | tgw-peering.
  • source-type — тип источника. Допустимые значения: igmp | static.
  • subnet-id — Идентификатор подсети.
  • transit-gateway-attachment-id — Идентификатор присоединения транзитного шлюза.

(структура)

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

Если вы указываете несколько фильтров, фильтры соединяются с помощью 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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI User Guide.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Для поиска одной или нескольких групп мультикаста транзитного шлюза и возврата информации о членстве в группе

Следующий пример search-transit-gateway-multicast-groups возвращает членство в группе указанной группы мультикаста.

aws ec2 search-transit-gateway-multicast-groups \
    --transit-gateway-multicast-domain-id tgw-mcast-domain-000fb24d04EXAMPLE

Вывод:

{
    "MulticastGroups": [
        {
            "GroupIpAddress": "224.0.1.0",
            "TransitGatewayAttachmentId": "tgw-attach-0372e72386EXAMPLE",
            "SubnetId": "subnet-0187aff814EXAMPLE",
            "ResourceId": "vpc-0065acced4EXAMPLE",
            "ResourceType": "vpc",
            "NetworkInterfaceId": "eni-03847706f6EXAMPLE",
            "GroupMember": false,
            "GroupSource": true,
            "SourceType": "static"
        }
    ]
}

Дополнительную информацию см. в разделе «Мультикаст на транзитных шлюзах» в Руководстве по транзитным шлюзам.

Вывод

MulticastGroups -> (список)

Информация о группе мультикаста транзитного шлюза.

(структура)

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

GroupIpAddress -> (строка)

IP-адрес, назначенный группе мультикаста транзитного шлюза.

TransitGatewayAttachmentId -> (строка)

Идентификатор присоединения транзитного шлюза.

SubnetId -> (строка)

Идентификатор подсети.

ResourceId -> (строка)

Идентификатор ресурса.

ResourceType -> (строка)

Тип ресурса, например, присоединение к VPC.

ResourceOwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей группой ресурсов домена мультикаста транзитного шлюза.

NetworkInterfaceId -> (строка)

Идентификатор присоединения транзитного шлюза.

GroupMember -> (логическое значение)

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

GroupSource -> (логическое значение)

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

MemberType -> (строка)

Тип члена (например, static).

SourceType -> (строка)

Тип источника.

NextToken -> (строка)

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

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

Spec-Zone.ru

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