Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

describe-target-health

Описание

Описывает состояние здоровья указанных целевых серверов или всех целевых серверов.

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

Синтаксис

  describe-target-health
--target-group-arn <value>
[--targets <value>]
[--include <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]

Параметры

--target-group-arn (строка)

Amazon Resource Name (ARN) группы целевых серверов.

--targets (список)

Целевые серверы.

(структура)

Информация о целевом сервере.

Id -> (строка)

Идентификатор целевого сервера. Если тип целевого сервера в группе целевых серверов — instance, укажите идентификатор экземпляра. Если тип целевого сервера — ip, укажите IP-адрес. Если тип целевого сервера — lambda, укажите ARN функции Lambda. Если тип целевого сервера — alb, укажите ARN целевого сервера Application Load Balancer.

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

Порт, на котором целевой сервер прослушивает подключения. Если протокол группы целевых серверов — GENEVE, поддерживаемый порт — 6081. Если тип целевого сервера — alb, целевой Application Load Balancer должен иметь хотя бы один слушатель с портом, соответствующим порту группы целевых серверов. Этот параметр не используется, если целевой сервер — функция Lambda.

AvailabilityZone -> (строка)

Зона доступности или all. Это определяет, получает ли целевой сервер трафик от узлов балансировщика нагрузки в указанной зоне доступности или от всех включенных зон доступности для балансировщика нагрузки.

Для групп целевых серверов Application Load Balancer значение указанной зоны доступности применимо только тогда, когда межзонная балансировка отключена. В противном случае параметр игнорируется и обрабатывается как all.

Этот параметр не поддерживается, если тип целевого сервера в группе целевых серверов — instance или alb.

Если тип целевого сервера — ip и IP-адрес находится в подсети VPC для группы целевых серверов, зона доступности автоматически определяется, и этот параметр является необязательным. Если IP-адрес находится за пределами VPC, этот параметр требуется.

Для групп целевых серверов Application Load Balancer с отключенной межзонной балансировкой, если тип целевого сервера — ip и IP-адрес находится за пределами VPC для группы целевых серверов, это должна быть зона доступности внутри VPC для группы целевых серверов.

Если тип целевого сервера — lambda, этот параметр является необязательным, и единственное поддерживаемое значение — all.

Сокращенный синтаксис:

Id=string,Port=integer,AvailabilityZone=string ...

Синтаксис JSON:

[
  {
    "Id": "string",
    "Port": integer,
    "AvailabilityZone": "string"
  }
  ...
]

--include (список)

Используется для включения информации об обнаружении аномалий.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AnomalyDetection
  All

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Пример 1: Описание состояния здоровья целевых серверов для группы целевых серверов

Следующий describe-target-health пример отображает подробности состояния здоровья целевых серверов указанной группы целевых серверов. Эти целевые серверы находятся в рабочем состоянии.

aws elbv2 describe-target-health \
    --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

Вывод:

{
    "TargetHealthDescriptions": [
        {
            "HealthCheckPort": "80",
            "Target": {
                "Id": "i-ceddcd4d",
                "Port": 80
            },
            "TargetHealth": {
                "State": "healthy"
            }
        },
        {
            "HealthCheckPort": "80",
            "Target": {
                "Id": "i-0f76fade",
                "Port": 80
            },
            "TargetHealth": {
                "State": "healthy"
            }
        }
    ]
}

Пример 2: Описание состояния здоровья целевого сервера

Следующий describe-target-health пример отображает подробности состояния здоровья указанного целевого сервера. Этот целевой сервер находится в рабочем состоянии.

aws elbv2 describe-target-health \
    --targets Id=i-0f76fade,Port=80 \
    --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

Вывод:

{
    "TargetHealthDescriptions": [
        {
            "HealthCheckPort": "80",
            "Target": {
                "Id": "i-0f76fade",
                "Port": 80
            },
            "TargetHealth": {
                "State": "healthy"
            }
        }
    ]
}

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

{
    "TargetHealthDescriptions": [
    {
        "HealthCheckPort": "80",
        "Target": {
            "Id": "i-0f76fade",
            "Port": 80
        },
            "TargetHealth": {
                "State": "unused",
                "Reason": "Target.NotInUse",
                "Description": "Target group is not configured to receive traffic from the load balancer"
            }
        }
    ]
}

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

{
    "TargetHealthDescriptions": [
        {
            "HealthCheckPort": "80",
            "Target": {
                "Id": "i-0f76fade",
                "Port": 80
            },
            "TargetHealth": {
                "State": "initial",
                "Reason": "Elb.RegistrationInProgress",
                "Description": "Target registration is in progress"
            }
        }
    ]
}

Следующий пример вывода относится к неисправному целевому серверу.

{
    "TargetHealthDescriptions": [
        {
            "HealthCheckPort": "80",
            "Target": {
                "Id": "i-0f76fade",
                "Port": 80
            },
            "TargetHealth": {
                "State": "unhealthy",
                "Reason": "Target.Timeout",
                "Description": "Connection to target timed out"
            }
        }
    ]
}

Следующий пример вывода относится к целевому серверу, который является функцией Lambda, и проверки работоспособности отключены.

{
    "TargetHealthDescriptions": [
        {
            "Target": {
                "Id": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
                "AvailabilityZone": "all",
            },
            "TargetHealth": {
                "State": "unavailable",
                "Reason": "Target.HealthCheckDisabled",
                "Description": "Health checks are not enabled for this target"
            }
        }
    ]
}

Вывод

TargetHealthDescriptions -> (список)

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

(структура)

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

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

Описание целевого узла.

Id -> (строка)

Идентификатор целевого узла. Если тип целевой группы - instance, укажите идентификатор экземпляра. Если тип целевого узла - ip, укажите IP-адрес. Если тип целевого узла - lambda, укажите ARN функции Lambda. Если тип целевого узла - alb, укажите ARN целевого узла Application Load Balancer.

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

Порт, на котором целевой узел прослушивает соединения. Если протокол целевой группы - GENEVE, поддерживаемый порт - 6081. Если тип целевого узла - alb, целевой Application Load Balancer должен иметь по крайней мере один слушатель, порт которого соответствует порту целевой группы. Этот параметр не используется, если целевой узел - функция Lambda.

AvailabilityZone -> (строка)

Доступная зона или all. Это определяет, получает ли целевой узел трафик от узлов балансировщика нагрузки в указанной доступной зоне или от всех включенных доступных зон для балансировщика нагрузки.

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

Этот параметр не поддерживается, если тип целевого узла целевой группы - instance или alb.

Если тип целевого узла - ip и IP-адрес находится в подсети VPC для целевой группы, доступная зона автоматически обнаруживается, и этот параметр необязателен. Если IP-адрес находится за пределами VPC, этот параметр обязателен.

Для целевых групп Application Load Balancer с отключенной межзонной балансировкой, если тип целевого узла - ip и IP-адрес находится за пределами VPC для целевой группы, это должна быть доступная зона внутри VPC для целевой группы.

Если тип целевого узла - lambda, этот параметр необязателен, и единственное поддерживаемое значение - all.

HealthCheckPort -> (строка)

Порт, используемый для подключения к целевому узлу.

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

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

State -> (строка)

Состояние целевого узла.

Reason -> (строка)

Код причины.

Если состояние целевого узла - healthy, код причины не предоставляется.

Если состояние целевого узла - initial, код причины может быть одним из следующих значений:

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

Если состояние целевого узла - unhealthy, код причины может быть одним из следующих значений:

  • Target.ResponseCodeMismatch - Проверки состояния не вернули ожидаемый HTTP-код. Применимо только к Application Load Balancers и Gateway Load Balancers.
  • Target.Timeout - Запросы проверки состояния истекли по времени. Применимо только к Application Load Balancers и Gateway Load Balancers.
  • Target.FailedHealthChecks - Балансировщик нагрузки получил ошибку при установлении соединения с целевым узлом или ответ целевого узла был неверным.
  • Elb.InternalError - Проверки состояния завершились неудачно из-за внутренней ошибки. Применимо только к Application Load Balancers.

Если состояние целевого узла - unused, код причины может быть одним из следующих значений:

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

Если состояние целевого узла - draining, код причины может быть следующим значением:

  • Target.DeregistrationInProgress - Целевой узел в процессе удаления, и период ожидания удаления еще не истек.

Если состояние целевого узла - unavailable, код причины может быть следующим значением:

  • Target.HealthCheckDisabled - Проверки состояния отключены для целевой группы. Применимо только к Application Load Balancers.
  • Elb.InternalError - Состояние здоровья целевого узла недоступно из-за внутренней ошибки. Применимо только к Network Load Balancers.

Description -> (строка)

Описание состояния целевого узла, предоставляющее дополнительные сведения. Если состояние - healthy, описание не предоставляется.

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

Результат обнаружения аномалий для целевого узла.

Если аномалии не обнаружены, результат - normal.

Если аномалии обнаружены, результат - anomalous.

Result -> (строка)

Последний результат обнаружения аномалий.

MitigationInEffect -> (строка)

Указывает, выполняется ли смягчение последствий аномалии.

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

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

State -> (строка)

Состояние переопределения.

Reason -> (строка)

Код причины состояния.

Description -> (строка)

Описание состояния переопределения, предоставляющее дополнительные сведения.

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

Spec-Zone.ru

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