Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-load-balancers

Описание

Возвращает информацию обо всех балансировках нагрузки в аккаунте.

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

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

Синтаксис

  get-load-balancers
[--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]

Параметры

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

Для получения информации обо всех балансировках нагрузки

Следующий пример get-load-balancers отображает сведения обо всех балансировках нагрузки в настроенном регионе AWS.

aws lightsail get-load-balancers

Вывод:

{
    "loadBalancers": [
        {
            "name": "LoadBalancer-1",
            "arn": "arn:aws:lightsail:us-west-2:111122223333:LoadBalancer/40486b2b-1ad0-4152-83e4-cEXAMPLE6f4b",
            "supportCode": "6EXAMPLE3362/arn:aws:elasticloadbalancing:us-west-2:333322221111:loadbalancer/app/bEXAMPLE128cb59d86f946a9395dd304/1EXAMPLE8dd9d77e",
            "createdAt": 1571677906.723,
            "location": {
                "availabilityZone": "all",
                "regionName": "us-west-2"
            },
            "resourceType": "LoadBalancer",
            "tags": [],
            "dnsName": "bEXAMPLE128cb59d86f946a9395dd304-1486911371.us-west-2.elb.amazonaws.com",
            "state": "active",
            "protocol": "HTTP",
            "publicPorts": [
                80
            ],
            "healthCheckPath": "/",
            "instancePort": 80,
            "instanceHealthSummary": [
                {
                    "instanceName": "MEAN-3",
                    "instanceHealth": "healthy"
                },
                {
                    "instanceName": "MEAN-1",
                    "instanceHealth": "healthy"
                },
                {
                    "instanceName": "MEAN-2",
                    "instanceHealth": "healthy"
                }
            ],
            "tlsCertificateSummaries": [
                {
                    "name": "example-com",
                    "isAttached": false
                }
            ],
            "configurationOptions": {
                "SessionStickinessEnabled": "false",
                "SessionStickiness_LB_CookieDurationSeconds": "86400"
            }
        }
    ]
}

Вывод

loadBalancers -> (список)

Массив объектов LoadBalancer, описывающих ваши балансировщики нагрузки.

(структура)

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

name -> (строка)

Имя балансировщика нагрузки (my-load-balancer).

arn -> (строка)

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

supportCode -> (строка)

Код поддержки. Включите этот код в ваше электронное письмо в службу поддержки, если у вас есть вопросы о вашем балансировщике нагрузки Lightsail. Этот код позволит нашей команде поддержки легче найти вашу информацию Lightsail.

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

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

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

AWS регион, в котором был создан ваш балансировщик нагрузки (us-east-2a). Lightsail автоматически создает балансировщик нагрузки в зонах доступности.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса (LoadBalancer).

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описывает ключ тега и необязательное значение, назначенные ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

dnsName -> (строка)

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

state -> (строка)

Статус вашего балансировщика нагрузки. Допустимые значения указаны ниже.

protocol -> (строка)

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

Вы не можете иметь только HTTP_HTTPS , но вы можете иметь только HTTP.

publicPorts -> (список)

Массив настроек публичных портов для вашего балансировщика нагрузки. Для HTTP используйте порт 80. Для HTTPS используйте порт 443.

(целое число)

healthCheckPath -> (строка)

Путь, который вы указали для выполнения проверок состояния. Если путь не указан, балансировщик нагрузки пытается выполнить запрос на домашнюю страницу (корневую страницу).

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

Порт, на который балансировщик нагрузки будет перенаправлять трафик на ваши экземпляры Lightsail. Для HTTP-трафика это порт 80. Для HTTPS-трафика это порт 443.

instanceHealthSummary -> (список)

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

(структура)

Описывает информацию о состоянии экземпляра.

instanceName -> (строка)

Имя экземпляра Lightsail, для которого запрашиваются данные проверки состояния.

instanceHealth -> (строка)

Описывает общее состояние экземпляра. Допустимые значения указаны ниже.

instanceHealthReason -> (строка)

Дополнительная информация о состоянии экземпляра. Если состояние instanceHealth равно healthy, то значение instanceHealthReason не предоставляется.

Если ** instanceHealth ** равно initial, то значение ** instanceHealthReason ** может быть одним из следующих:

  • **Lb.RegistrationInProgress ** - Целевой экземпляр находится в процессе регистрации с балансировщиком нагрузки.
  • **Lb.InitialHealthChecking ** - Балансировщик нагрузки Lightsail по-прежнему отправляет целевому экземпляру минимальное количество проверок состояния, необходимых для определения его состояния.

Если ** instanceHealth ** равно unhealthy, то значение ** instanceHealthReason ** может быть одним из следующих:

  • **Instance.ResponseCodeMismatch ** - Проверки состояния не вернули ожидаемый HTTP-код.
  • **Instance.Timeout ** - Запросы проверки состояния истекли.
  • **Instance.FailedHealthChecks ** - Проверки состояния завершились неудачей, так как соединение с целевым экземпляром истекло, ответ целевого экземпляра был неверным или целевой экземпляр не прошёл проверку состояния по неизвестной причине.
  • **Lb.InternalError ** - Проверки состояния завершились неудачей из-за внутренней ошибки.

Если ** instanceHealth ** равно unused, то значение ** instanceHealthReason ** может быть одним из следующих:

  • **Instance.NotRegistered ** - Целевой экземпляр не зарегистрирован в целевой группе.
  • **Instance.NotInUse ** - Целевая группа не используется ни одним балансировщиком нагрузки или целевой экземпляр находится в зоне доступности, которая не включена для своего балансировщика нагрузки.
  • **Instance.IpUnusable ** - Целевой IP-адрес зарезервирован для использования балансировщиком нагрузки Lightsail.
  • **Instance.InvalidState ** - Целевой экземпляр остановлен или завершен.

Если ** instanceHealth ** равно draining, то значение ** instanceHealthReason ** может быть одним из следующих:

  • **Instance.DeregistrationInProgress ** - Целевой экземпляр находится в процессе дерегистрации, и период ожидания дерегистрации не истек.

tlsCertificateSummaries -> (список)

Массив объектов LoadBalancerTlsCertificateSummary, предоставляющих дополнительную информацию о сертификатах SSL/TLS. Например, если true, сертификат прикреплен к балансировщику нагрузки.

(структура)

Предоставляет сводку метаданных сертификата SSL/TLS.

name -> (строка)

Имя сертификата SSL/TLS.

isAttached -> (логическое значение)

Если true, сертификат SSL/TLS прикреплен к балансировщику нагрузки Lightsail.

configurationOptions -> (мапа)

Строка-строковая карта параметров конфигурации вашего балансировщика нагрузки. Допустимые значения перечислены ниже.

key -> (строка)

value -> (строка)

ipAddressType -> (строка)

Тип IP-адреса балансировщика нагрузки.

Возможные значения: ipv4 для только IPv4, ipv6 для только IPv6 и dualstack для IPv4 и IPv6.

httpsRedirectionEnabled -> (логическое значение)

Булево значение, указывающее, включена ли переадресация HTTPS для балансировщика нагрузки.

tlsPolicyName -> (строка)

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

nextPageToken -> (строка)

Токен для перехода к следующей странице результатов вашего запроса.

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

Чтобы получить следующую страницу результатов, выполните другой запрос GetLoadBalancers и укажите токен следующей страницы с помощью параметра pageToken.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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