Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

describe-direct-connect-gateway-associations

Описание

Перечисляет ассоциации между вашими шлюзами Direct Connect и виртуальными частными шлюзами и шлюзами транзита. Вы должны указать одно из следующего:

  • Шлюз Direct Connect. Ответ содержит все виртуальные частные шлюзы и шлюзы транзита, связанные со шлюзом Direct Connect.
  • Виртуальный частный шлюз. Ответ содержит шлюз Direct Connect.
  • Шлюз транзита. Ответ содержит шлюз Direct Connect.
  • Шлюз Direct Connect и виртуальный частный шлюз. Ответ содержит ассоциацию между шлюзом Direct Connect и виртуальным частным шлюзом.
  • Шлюз Direct Connect и шлюз транзита. Ответ содержит ассоциацию между шлюзом Direct Connect и шлюзом транзита.
  • Шлюз Direct Connect и виртуальный частный шлюз. Ответ содержит ассоциацию между шлюзом Direct Connect и виртуальным частным шлюзом.
  • Ассоциация шлюза Direct Connect с ядром сети Cloud WAN. Ответ содержит идентификатор ядра сети Cloud WAN, к которому связан шлюз Direct Connect.

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

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

Синтаксис

  describe-direct-connect-gateway-associations
[--association-id <value>]
[--associated-gateway-id <value>]
[--direct-connect-gateway-id <value>]
[--virtual-gateway-id <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]

Параметры

--association-id (строка)

Идентификатор ассоциации шлюза Direct Connect.

--associated-gateway-id (строка)

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

--direct-connect-gateway-id (строка)

Идентификатор шлюза Direct Connect.

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

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-предоставленного значения, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-службы.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов, возвращаемых в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничность в Руководстве пользователя командной строки AWS.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для описания ассоциаций шлюзов Direct Connect

Следующий пример описывает все ассоциации со шлюзом Direct Connect 5f294f92-bafb-4011-916d-9b0bexample.

Команда:

aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample

Вывод:

{
  "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9",
  "directConnectGatewayAssociations": [
      {
          "associationState": "associating",
          "virtualGatewayOwnerAccount": "123456789012",
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
          "virtualGatewayId": "vgw-6efe725e",
          "virtualGatewayRegion": "us-east-2"
      },
      {
          "associationState": "disassociating",
          "virtualGatewayOwnerAccount": "123456789012",
          "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
          "virtualGatewayId": "vgw-ebaa27db",
          "virtualGatewayRegion": "us-east-2"
      }
  ]
}

Вывод

directConnectGatewayAssociations -> (список)

Информация об ассоциациях.

(структура)

Информация об ассоциации между шлюзом Direct Connect и виртуальным частным шлюзом или шлюзом транзита.

directConnectGatewayId -> (строка)

Идентификатор шлюза Direct Connect.

directConnectGatewayOwnerAccount -> (строка)

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

associationState -> (строка)

Состояние ассоциации. Возможные значения:

  • associating : Начальное состояние после вызова CreateDirectConnectGatewayAssociation .
  • associated : Шлюз Direct Connect и виртуальный частный шлюз или шлюз транзита успешно связаны и готовы пропускать трафик.
  • disassociating : Начальное состояние после вызова DeleteDirectConnectGatewayAssociation .
  • disassociated : Виртуальный частный шлюз или шлюз транзита отключен от шлюза Direct Connect. Поток трафика между шлюзом Direct Connect и виртуальным частным шлюзом или шлюзом транзита остановлен.
  • updating : Блоки CIDR для виртуального частного шлюза или шлюза транзита в настоящее время обновляются. Это может быть добавление новых блоков CIDR или удаление существующих.

stateChangeError -> (строка)

Сообщение об ошибке, если состояние объекта не удалось изменить.

associatedGateway -> (структура)

Информация о связанном шлюзе.

id -> (строка)

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

type -> (строка)

Тип связанного шлюза.

ownerAccount -> (строка)

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

region -> (строка)

Регион расположения связанного шлюза.

associationId -> (строка)

Идентификатор ассоциации шлюза Direct Connect.

allowedPrefixesToDirectConnectGateway -> (список)

Префиксы Amazon VPC для рекламы шлюзу Direct Connect.

(структура)

Информация о префиксе фильтра маршрутов, который клиент может рекламировать через протокол Border Gateway Protocol (BGP) по общедоступному виртуальному интерфейсу.

cidr -> (строка)

Блок CIDR для рекламируемого маршрута. Несколько маршрутов разделяются запятыми. Для IPv6 CIDR необходимо использовать /64 или меньшую длину.

associatedCoreNetwork -> (структура)

Идентификатор ядра Cloud WAN, связанного с подключением шлюза Direct Connect.

id -> (строка)

Идентификатор ядра Cloud WAN, к которому связан шлюз Direct Connect.

ownerAccount -> (строка)

Владелец учетной записи ядра Cloud WAN.

attachmentId -> (строка)

Идентификатор подключения шлюза Direct Connect.

virtualGatewayId -> (строка)

Идентификатор виртуального частного шлюза. Применяется только к частным виртуальным интерфейсам.

virtualGatewayRegion -> (строка)

Регион Amazon Web Services, в котором находится виртуальный частный шлюз.

virtualGatewayOwnerAccount -> (строка)

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

nextToken -> (строка)

Токен для получения следующей страницы.

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

Spec-Zone.ru

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