Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

describe-listeners

Описание

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

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

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

Синтаксис

  describe-listeners
[--load-balancer-arn <value>]
[--listener-arns <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--load-balancer-arn (строка)

Amazon Resource Name (ARN) балансировщика нагрузки.

--listener-arns (список)

Amazon Resource Names (ARN) слушателей.

(строка)

Синтаксис:

"string" "string" ...

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

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

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

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

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

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

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя 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 (булево)

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

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

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

Примеры

Примечание

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

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

Для описания слушателя

Этот пример описывает указанный слушатель.

Команда:

aws elbv2 describe-listeners --listener-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2

Вывод:

{
  "Listeners": [
      {
          "Port": 80,
          "Protocol": "HTTP",
          "DefaultActions": [
              {
                  "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
                  "Type": "forward"
              }
          ],
          "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
          "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
      }
  ]
}

Для описания слушателей для балансировщика нагрузки

Этот пример описывает слушателей для указанного балансировщика нагрузки.

Команда:

aws elbv2 describe-listeners --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188

Вывод:

{
  "Listeners": [
      {
          "Port": 443,
          "Protocol": "HTTPS",
          "DefaultActions": [
              {
                  "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
                  "Type": "forward"
              }
          ],
          "SslPolicy": "ELBSecurityPolicy-2015-05",
          "Certificates": [
              {
                  "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
              }
          ],
          "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
          "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65"
      },
      {
          "Port": 80,
          "Protocol": "HTTP",
          "DefaultActions": [
              {
                  "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
                  "Type": "forward"
              }
          ],
          "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
          "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
      }
  ]
}

Вывод

Слушатели -> (список)

Информация о слушателях.

(структура)

Информация о слушателе.

ListenerArn -> (строка)

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

LoadBalancerArn -> (строка)

Идентификатор ресурса Amazon (ARN) балансировщика нагрузки.

Порт -> (целое число)

Порт, на котором балансировщик нагрузки прослушивает соединения.

Протокол -> (строка)

Протокол для соединений клиентов с балансировщиком нагрузки.

Сертификаты -> (список)

[Слушатель HTTPS или TLS] По умолчанию используется сертификат для слушателя.

(структура)

Информация о сертификате SSL-сервера.

CertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) сертификата.

IsDefault -> (булево)

Указывает, является ли сертификат сертификатом по умолчанию. Не устанавливайте это значение при указании сертификата как входных данных. Это значение не включено в выходные данные при описании слушателя, но включено при описании сертификатов слушателя.

SslPolicy -> (строка)

[Слушатель HTTPS или TLS] Политика безопасности, определяющая, какие протоколы и шифры поддерживаются.

DefaultActions -> (список)

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

(структура)

Информация о действии.

Каждое правило должно включать ровно один из следующих типов действий: forward , fixed-response , или redirect, и это должно быть последнее выполняемое действие.

Тип -> (строка)

Тип действия.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целевых серверов. Указывается только когда Type является forward и необходимо маршрутизировать трафик на единственную группу целевых серверов. Чтобы маршрутизировать трафик на одну или несколько групп целевых серверов, используйте ForwardConfig.

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

[Слушатели HTTPS] Информация об идентификаторе поставщика, соответствующем OpenID Connect (OIDC). Указывается только тогда, когда Type равно authenticate-oidc.

Issuer -> (строка)

Идентификатор издателя OIDC поставщика услуг. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

AuthorizationEndpoint -> (строка)

Конечная точка авторизации поставщика услуг. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

TokenEndpoint -> (строка)

Конечная точка получения токена поставщика услуг. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

UserInfoEndpoint -> (строка)

Конечная точка для получения информации о пользователе поставщика услуг. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

ClientId -> (строка)

Идентификатор клиента OAuth 2.0.

ClientSecret -> (строка)

Секрет клиента OAuth 2.0. Требуется при создании правила. Если вы изменяете правило, можно опустить этот параметр, если установить UseExistingClientSecret в значение true.

SessionCookieName -> (строка)

Имя cookie, используемого для сохранения информации о сессии. По умолчанию — AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских данных, которые должны быть запрошены у поставщика услуг. По умолчанию — openid.

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

SessionTimeout -> (длинное целое число)

Максимальная продолжительность сессии аутентификации в секундах. По умолчанию — 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (карта)

Параметры запроса (до 10) для включения в запрос перенаправления на конечную точку авторизации.

ключ -> (строка)

значение -> (строка)

OnUnauthenticatedRequest -> (строка)

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

  • deny- Возврат ошибки HTTP 401 Unauthorized.
  • allow- Разрешение перенаправления запроса к целевому ресурсу.
  • authenticate- Перенаправление запроса на конечную точку авторизации поставщика услуг. Это значение по умолчанию.

UseExistingClientSecret -> (булево)

Указывает, использовать ли существующий секрет клиента при изменении правила. При создании правила можно опустить этот параметр или установить его в значение false.

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

[Слушатели HTTPS] Информация для использования Amazon Cognito для аутентификации пользователей. Указывается только когда Type равно authenticate-cognito.

UserPoolArn -> (строка)

Идентификатор ресурса Amazon (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

Идентификатор клиента пула пользователей Amazon Cognito.

UserPoolDomain -> (строка)

Префикс домена или полное доменное имя пула пользователей Amazon Cognito.

SessionCookieName -> (строка)

Имя cookie, используемого для сохранения информации о сессии. По умолчанию — AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских данных, которые должны быть запрошены у поставщика услуг. По умолчанию — openid.

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

SessionTimeout -> (длинное целое число)

Максимальная продолжительность сессии аутентификации в секундах. По умолчанию — 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (карта)

Параметры запроса (до 10) для включения в запрос перенаправления на конечную точку авторизации.

ключ -> (строка)

значение -> (строка)

OnUnauthenticatedRequest -> (строка)

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

  • deny- Возврат ошибки HTTP 401 Unauthorized.
  • allow- Разрешение перенаправления запроса к целевому ресурсу.
  • authenticate- Перенаправление запроса на конечную точку авторизации поставщика услуг. Это значение по умолчанию.

Порядок -> (целое число)

Порядок выполнения действия. Требуется для правил с несколькими действиями. Действие с наименьшим значением порядка выполняется первым.

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

[Балансировщик нагрузки приложений] Информация для создания действия перенаправления. Указывается только когда Type равно redirect.

Протокол -> (строка)

Протокол. Можно указать HTTP, HTTPS или #{protocol}. Можно перенаправлять HTTP на HTTP, HTTP на HTTPS и HTTPS на HTTPS. Нельзя перенаправлять HTTPS на HTTP.

Порт -> (строка)

Порт. Можно указать значение от 1 до 65535 или #{port}.

Хост -> (строка)

Имя хоста. Эта часть не кодируется по процентам. Имя хоста может содержать #{host}.

Путь -> (строка)

Абсолютный путь, начинающийся с ведущей “/”. Эта часть не кодируется по процентам. Путь может содержать #{host}, #{path} и #{port}.

Запрос -> (строка)

Параметры запроса, закодированные по URL при необходимости, но не закодированные по процентам. Не включайте ведущую “?”, так как она добавляется автоматически. Можно указать любые зарезервированные ключевые слова.

Код состояния -> (строка)

Код HTTP перенаправления. Перенаправление может быть постоянным (HTTP 301) или временным (HTTP 302).

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

[Балансировщик нагрузки приложений] Информация для создания действия, возвращающего пользовательский HTTP-ответ. Указывается только когда Type равно fixed-response.

Тело сообщения -> (строка)

Сообщения.

Код состояния -> (строка)

Код HTTP-ответа (2XX, 4XX или 5XX).

Тип содержимого -> (строка)

Тип содержимого.

Допустимые значения: text/plain | text/css | text/html | application/javascript | application/json

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

Информация для создания действия, распределяющего запросы между одной или несколькими группами целевых серверов. Для балансировщиков сетевой нагрузки можно указать одну группу целевых серверов. Указывается только когда Type равно forward. Если вы указываете как ForwardConfig, так и TargetGroupArn, вы можете указать только одну группу целевых серверов, используя ForwardConfig, и она должна быть той же самой группой, что и в TargetGroupArn.

TargetGroups -> (список)

Группы целевых серверов. Для балансировщиков сетевой нагрузки можно указать одну группу целевых серверов.

(структура)

Информация о том, как трафик будет распределяться между несколькими группами целевых серверов в правиле перенаправления.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целевых серверов.

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

Вес. Диапазон значений — от 0 до 999.

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

Настройка привязки к группе целевых серверов для правила.

Enabled -> (булево)

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

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

Срок действия, в секундах, в течение которого запросы от клиента должны маршрутизироваться к той же группе целевых серверов. Диапазон — от 1 до 604800 секунд (7 дней).

AlpnPolicy -> (список)

[Слушатель TLS] Название политики Application-Layer Protocol Negotiation (ALPN).

(строка)

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

Конфигурация взаимной аутентификации.

Режим -> (строка)

Метод обработки клиентского сертификата. Возможные варианты — off, passthrough или verify. Значение по умолчанию — off.

TrustStoreArn -> (строка)

Идентификатор ресурса Amazon (ARN) хранилища доверия.

IgnoreClientCertificateExpiry -> (булево)

Указывает, игнорировать ли истекшие клиентские сертификаты.

TrustStoreAssociationStatus -> (строка)

Указывает состояние ассоциации хранилищ доверия.

AdvertiseTrustStoreCaNames -> (строка)

Указывает, рекламировать ли имена сертификатов CA хранилища доверия.

NextMarker -> (строка)

Если есть дополнительные результаты, это маркер для следующего набора результатов. В противном случае — null.

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

Spec-Zone.ru

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