Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-load-balancer

Описание

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

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

Синтаксис

  get-load-balancer
--load-balancer-name <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]

Параметры

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

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

--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
  • text
  • таблица
  • 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 User Guide.

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

Чтобы получить информацию о балансировщике нагрузки

Следующий get-load-balancer пример отображает подробную информацию о заданном балансировщике нагрузки.

aws lightsail get-load-balancer \
    --load-balancer-name LoadBalancer-1

Вывод:

{
    "loadBalancer": {
        "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"
        }
    }
}

Вывод

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 для балансировщика нагрузки.

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

Spec-Zone.ru

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