Spec-Zone.ru › AWS CLI v2

[ aws . elb ]

describe-load-balancers

Описание

Описывает указанные балансировщики нагрузки. Если балансировщики нагрузки не указаны, вызов описывает все ваши балансировщики нагрузки.

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

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

Синтаксис

  describe-load-balancers
[--load-balancer-names <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-names (список)

Имена балансировщиков нагрузки.

(строка)

Синтаксис:

"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 elb describe-load-balancers

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

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

Команда:

aws elb describe-load-balancers --load-balancer-name my-load-balancer

Следующий пример ответа относится к балансировщику нагрузки HTTPS в VPC.

Вывод:

{
  "LoadBalancerDescriptions": [
    {
      "Subnets": [
          "subnet-15aaab61"
      ],
      "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE",
      "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com",
      "ListenerDescriptions": [
          {
              "Listener": {
                  "InstancePort": 80,
                  "LoadBalancerPort": 80,
                  "Protocol": "HTTP",
                  "InstanceProtocol": "HTTP"
              },
              "PolicyNames": []
          },
          {
              "Listener": {
                  "InstancePort": 443,
                  "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert",
                  "LoadBalancerPort": 443,
                  "Protocol": "HTTPS",
                  "InstanceProtocol": "HTTPS"
              },
              "PolicyNames": [
                  "ELBSecurityPolicy-2015-03"
              ]
          }
      ],
      "HealthCheck": {
          "HealthyThreshold": 2,
          "Interval": 30,
          "Target": "HTTP:80/png",
          "Timeout": 3,
          "UnhealthyThreshold": 2
      },
      "VPCId": "vpc-a01106c2",
      "BackendServerDescriptions": [
          {
              "InstancePort": 80,
              "PolicyNames": [
                  "my-ProxyProtocol-policy"
              ]
          }
      ],
      "Instances": [
          {
              "InstanceId": "i-207d9717"
          },
          {
              "InstanceId": "i-afefb49b"
          }
      ],
      "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com",
      "SecurityGroups": [
          "sg-a61988c3"
      ],
      "Policies": {
          "LBCookieStickinessPolicies": [
              {
                  "PolicyName": "my-duration-cookie-policy",
                  "CookieExpirationPeriod": 60
              }
          ],
          "AppCookieStickinessPolicies": [],
          "OtherPolicies": [
              "my-PublicKey-policy",
              "my-authentication-policy",
              "my-SSLNegotiation-policy",
              "my-ProxyProtocol-policy",
              "ELBSecurityPolicy-2015-03"
          ]
      },
      "LoadBalancerName": "my-load-balancer",
      "CreatedTime": "2015-03-19T03:24:02.650Z",
      "AvailabilityZones": [
          "us-west-2a"
      ],
      "Scheme": "internet-facing",
      "SourceSecurityGroup": {
          "OwnerAlias": "123456789012",
          "GroupName": "my-elb-sg"
      }
    }
  ]
}

Вывод

LoadBalancerDescriptions -> (список)

Информация о балансировщиках нагрузки.

(структура)

Информация о балансировщике нагрузки.

LoadBalancerName -> (строка)

Название балансировщика нагрузки.

DNSName -> (строка)

DNS-имя балансировщика нагрузки.

CanonicalHostedZoneName -> (строка)

DNS-имя балансировщика нагрузки.

Дополнительную информацию см. в руководстве по классическим балансировщикам нагрузки в разделе «Настройка доменного имени».

CanonicalHostedZoneNameID -> (строка)

Идентификатор доменной зоны Amazon Route 53 для балансировщика нагрузки.

ListenerDescriptions -> (список)

Слушатели балансировщика нагрузки.

(структура)

Настроенные политики для слушателя.

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

Слушатель.

Protocol -> (строка)

Протокол транспортного уровня балансировщика нагрузки для маршрутизации: HTTP, HTTPS, TCP или SSL.

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

Порт, на котором балансировщик нагрузки прослушивает подключения. В EC2-VPC можно указать любой порт в диапазоне от 1 до 65535. В EC2-Classic можно указать любой порт из следующего списка: 25, 80, 443, 465, 587, 1024-65535.

InstanceProtocol -> (строка)

Протокол для маршрутизации трафика к экземплярам: HTTP, HTTPS, TCP или SSL.

Если протокол переднего плана — TCP или SSL, протокол заднего плана должен быть TCP или SSL. Если протокол переднего плана — HTTP или HTTPS, протокол заднего плана должен быть HTTP или HTTPS.

Если имеется другой слушатель с тем же InstancePort, чей InstanceProtocol защищен (HTTPS или SSL), то протокол слушателя также должен быть защищенным.

Если имеется другой слушатель с тем же InstancePort, чей InstanceProtocol это HTTP или TCP, то протокол слушателя должен быть HTTP или TCP.

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

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

SSLCertificateId -> (строка)

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

PolicyNames -> (список)

Политики. Если политики не настроены, список пуст.

(строка)

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

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

AppCookieStickinessPolicies -> (список)

Политики кэширования, созданные с помощью CreateAppCookieStickinessPolicy.

(структура)

Информация о политике кэширования сессий, управляемой приложением.

PolicyName -> (строка)

Мемоническое имя политики. Имя должно быть уникальным для набора политик этого балансировщика нагрузки.

CookieName -> (строка)

Имя cookie приложения, используемого для кэширования.

LBCookieStickinessPolicies -> (список)

Политики кэширования, созданные с помощью CreateLBCookieStickinessPolicy.

(структура)

Информация о политике кэширования сессий по времени.

PolicyName -> (строка)

Имя политики. Имя должно быть уникальным для набора политик этого балансировщика нагрузки.

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

Срок действия cookie в секундах. Если этот параметр не указан, сессия кэширования действует до закрытия браузера.

OtherPolicies -> (список)

Политики, помимо политик кэширования.

(строка)

BackendServerDescriptions -> (список)

Информация об экземплярах EC2.

(структура)

Информация о конфигурации экземпляра EC2.

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

Порт, на котором прослушивает экземпляр EC2.

PolicyNames -> (список)

Имена политик, включенных для экземпляра EC2.

(строка)

AvailabilityZones -> (список)

Доступные зоны балансировщика нагрузки.

(строка)

Subnets -> (список)

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

(строка)

VPCId -> (строка)

Идентификатор VPC для балансировщика нагрузки.

Instances -> (список)

Идентификаторы экземпляров для балансировщика нагрузки.

(структура)

Идентификатор экземпляра EC2.

InstanceId -> (строка)

Идентификатор экземпляра.

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

Информация о проверке работоспособности балансировщика нагрузки.

Target -> (строка)

Проверяемый экземпляр. Протокол может быть TCP, HTTP, HTTPS или SSL. Допустимый диапазон портов — от 1 до 65535.

TCP по умолчанию, указывается как пара TCP:порт, например «TCP:5000». В этом случае проверка работоспособности просто пытается открыть TCP-соединение с экземпляром на указанном порте. Отсутствие подключения в течение заданного времени считается неработоспособностью.

SSL также указывается как пара SSL:порт, например, SSL:5000.

Для HTTP/HTTPS необходимо указать путь для проверки в строке. HTTP указывается как группа HTTP:порт;/;ПутьДоПроверки; , например «HTTP:80/weather/us/wa/seattle». В этом случае к экземпляру на указанном порте и пути отправляется HTTP-запрос GET. Любой ответ, кроме «200 OK», в течение заданного времени считается неработоспособностью.

Общий размер целевого пути HTTP должен быть не более 1024 16-битных символов Юникода.

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

Приблизительный интервал в секундах между проверками работоспособности отдельных экземпляров.

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

Время в секундах, в течение которого отсутствие ответа означает неисправность.

Это значение должно быть меньше значения Interval.

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

Количество последовательных сбоев проверки работоспособности, необходимое для перевода экземпляра в состояние Unhealthy.

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

Количество последовательных успешных проверок работоспособности, необходимое для перевода экземпляра в состояние Healthy.

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

Группа безопасности для балансировщика нагрузки, которую можно использовать в составе правил входящего трафика для зарегистрированных экземпляров. Чтобы разрешить трафик только от балансировщиков, добавьте правило группы безопасности, указывающее эту группу безопасности как источник входящего трафика.

OwnerAlias -> (строка)

Владелец группы безопасности.

GroupName -> (строка)

Имя группы безопасности.

SecurityGroups -> (список)

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

(строка)

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

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

Scheme -> (строка)

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

Если Scheme равно internet-facing, балансировщик нагрузки имеет общедоступное DNS-имя, которое разрешается до общедоступного IP-адреса.

Если Scheme равно internal, балансировщик нагрузки имеет общедоступное DNS-имя, которое разрешается до частного IP-адреса.

NextMarker -> (строка)

Маркер для запроса следующего набора результатов. Если дополнительных результатов нет, строка пустая.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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