Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

describe-hosted-connections

Описание

Отображает подключенные соединения, которые были настроены на указанном межсетевом соединении или группе агрегирования каналов (LAG).

Примечание

Предназначено только для использования партнёрами Direct Connect.

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

Синтаксис

  describe-hosted-connections
--connection-id <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

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

Идентификатор межсетевого соединения или LAG.

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

--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.

Для отображения подключений на межсетевом соединении

В следующем примере отображаются соединения, которые были настроены на заданном межсетевом соединении.

Команда:

aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66

Вывод:

{
    "connections": [
        {
            "partnerName": "TIVIT",
            "vlan": 101,
            "ownerAccount": "123456789012",
            "connectionId": "dxcon-ffzc51m1",
            "connectionState": "ordering",
            "bandwidth": "500Mbps",
            "location": "TIVIT",
            "connectionName": "mydcinterconnect",
            "region": "sa-east-1"
        }
    ]
}

Вывод

connections -> (список)

Подключения.

(структура)

Информация о подключении Direct Connect.

ownerAccount -> (строка)

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

connectionId -> (строка)

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

connectionName -> (строка)

Имя подключения.

connectionState -> (строка)

Состояние подключения. Следующие являются возможными значениями:

  • ordering : Начальное состояние подключенного соединения, настроенного на межсетевом соединении. Подключение остается в состоянии заказа, пока владелец подключенного соединения не подтвердит или не отклонит заказ подключения.
  • requested : Начальное состояние стандартного подключения. Подключение остается в состоянии запроса, пока письмо об авторизации (LOA) не будет отправлено клиенту.
  • pending : Подключение одобрено и инициируется.
  • available : Сеть подключена и подключение готово к использованию.
  • down : Сеть отключена.
  • deleting : Подключение удаляется.
  • deleted : Подключение удалено.
  • rejected : Подключенное соединение в состоянии ordering переходит в состояние rejected, если оно удаляется клиентом.
  • unknown : Состояние подключения недоступно.

region -> (строка)

Регион Amazon Web Services, в котором находится подключение.

location -> (строка)

Расположение подключения.

bandwidth -> (строка)

Пропускная способность подключения.

vlan -> (целое число)

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

partnerName -> (строка)

Имя поставщика услуг Direct Connect, связанного с подключением.

loaIssueTime -> (метка времени)

Время последнего вызова DescribeLoa для этого подключения.

lagId -> (строка)

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

awsDevice -> (строка)

Точка подключения Direct Connect, в которой завершается физическое соединение.

jumboFrameCapable -> (булево)

Указывает, поддерживаются ли кадр большого размера.

awsDeviceV2 -> (строка)

Точка подключения Direct Connect, в которой завершается физическое соединение.

awsLogicalDeviceId -> (строка)

Точка подключения Direct Connect, в которой завершается логическое соединение. Это устройство может отличаться от устройства, в котором завершается физическое соединение.

hasLogicalRedundancy -> (строка)

Указывает, поддерживает ли подключение вторичный BGP-узел в той же адресной семье (IPv4/IPv6).

tags -> (список)

Теги, связанные с подключением.

(структура)

Информация о теге.

key -> (строка)

Ключ.

value -> (строка)

Значение.

providerName -> (строка)

Название поставщика услуг, связанного с подключением.

macSecCapable -> (булево)

Указывает, поддерживает ли подключение MAC Security (MACsec).

portEncryptionStatus -> (строка)

Статус подключения порта MAC Security (MACsec).

Допустимые значения - Encryption Up , что означает, что существует активное имя ключа подключения, или Encryption Down .

encryptionMode -> (строка)

Режим шифрования MAC Security (MACsec) подключения.

Допустимые значения - no_encrypt , should_encrypt и must_encrypt .

macSecKeys -> (список)

Ключи безопасности MAC Security (MACsec), связанные с подключением.

(структура)

Информация о секретном ключе MAC Security (MACsec).

secretARN -> (строка)

Amazon Resource Name (ARN) секретного ключа MAC Security (MACsec).

ckn -> (строка)

Имя ключа подключения (CKN) для секретного ключа MAC Security.

state -> (строка)

Состояние секретного ключа MAC Security (MACsec).

Возможные значения:

  • associating : Секретный ключ MAC Security (MACsec) проверяется и еще не связан с подключением или LAG.
  • associated : Секретный ключ MAC Security (MACsec) проверен и связан с подключением или LAG.
  • disassociating : Секретный ключ MAC Security (MACsec) отключается от подключения или LAG.
  • disassociated : Секретный ключ MAC Security (MACsec) больше не связан с подключением или LAG.

startOn -> (строка)

Дата вступления в силу секретного ключа MAC Security (MACsec). Значение отображается в формате UTC.

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

Spec-Zone.ru

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