Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

получить-слушатель

Описание

Получает информацию о заданном слушателе для указанной службы.

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

Синтаксис

  get-listener
--listener-identifier <value>
--service-identifier <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]

Параметры

--listener-identifier (строка)

Идентификатор или ARN слушателя.

--service-identifier (строка)

Идентификатор или ARN службы.

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

Чтобы получить информацию о слушателе службы

Следующий get-listener пример получает информацию о заданном слушателе для указанной службы.

aws vpc-lattice get-listener \
    --listener-identifier listener-0ccf55918cEXAMPLE \
    --service-identifier svc-0285b53b2eEXAMPLE

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE/listener/listener-0ccf55918cEXAMPLE",
    "createdAt": "2023-05-07T05:08:45.192Z",
    "defaultAction": {
        "forward": {
            "targetGroups": [
                {
                    "targetGroupIdentifier": "tg-0ff213abb6EXAMPLE",
                    "weight": 1
                }
            ]
        }
    },
    "id": "listener-0ccf55918cEXAMPLE",
    "lastUpdatedAt": "2023-05-07T05:08:45.192Z",
    "name": "http-80",
    "port": 80,
    "protocol": "HTTP",
    "serviceArn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "serviceId": "svc-0285b53b2eEXAMPLE"
}

Для получения дополнительной информации см. Определение маршрутизации в руководстве пользователя Amazon VPC Lattice.

Вывод

arn -> (строка)

Amazon Resource Name (ARN) слушателя.

createdAt -> (временная метка)

Дата и время создания слушателя в формате ISO-8601.

defaultAction -> (структура помеченного союза)

Действия для правила слушателя по умолчанию.

Примечание

Это структура помеченного союза. Может быть установлено только одно из следующих ключей верхнего уровня: fixedResponse, forward.

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

Действие фиксированного ответа. Правило возвращает пользовательский HTTP-ответ.

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

Код HTTP-ответа.

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

Действие перенаправления. Трафик, соответствующий правилу, перенаправляется на указанные группы целей.

targetGroups -> (список)

Группы целей. Трафик, соответствующий правилу, перенаправляется на указанные группы целей. При действиях перенаправления можно назначить вес, который контролирует приоритезацию и выбор каждой группы целей. Это означает, что запросы распределяются по отдельным группам целей на основе их весов. Например, если две группы целей имеют одинаковый вес, каждая группа целей получает половину трафика.

Значение по умолчанию равно 1. Это означает, что если указана только одна группа целей, нет необходимости устанавливать вес; 100% трафика переходит в эту группу целей.

(структура)

Описывает вес группы целей.

targetGroupIdentifier -> (строка)

Идентификатор или ARN группы целей.

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

Требуется только если вы указываете несколько групп целей для действия перенаправления. Вес определяет, как запросы распределяются по группе целей. Например, если вы указываете две группы целей, каждая с весом 10, каждая группа целей получает половину запросов. Если вы указываете две группы целей, одну с весом 10, а другую с весом 20, группа целей с весом 20 получает в два раза больше запросов, чем другая группа целей. Если указана только одна группа целей, то значение по умолчанию - 100.

id -> (строка)

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

lastUpdatedAt -> (временная метка)

Дата и время последнего обновления слушателя в формате ISO-8601.

name -> (строка)

Имя слушателя.

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

Порт слушателя.

protocol -> (строка)

Протокол слушателя.

serviceArn -> (строка)

Amazon Resource Name (ARN) службы.

serviceId -> (строка)

Идентификатор службы.

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

Spec-Zone.ru

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