describe-target-group-attributes

Описание

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

Дополнительную информацию можно найти по следующим ссылкам:

Атрибуты группы целевых серверов в руководстве Application Load Balancers
Атрибуты группы целевых серверов в руководстве Network Load Balancers
Атрибуты группы целевых серверов в руководстве Gateway Load Balancers

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

Синтаксис

  describe-target-group-attributes
--target-group-arn <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) группы целевых серверов.

--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
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

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

Для описания атрибутов группы целевых серверов

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

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

Вывод включает атрибуты, если протокол HTTP или HTTPS, а тип целевого сервера instance или ip.

{
    "Attributes": [
        {
            "Value": "false",
            "Key": "stickiness.enabled"
        },
        {
            "Value": "300",
            "Key": "deregistration_delay.timeout_seconds"
        },
        {
            "Value": "lb_cookie",
            "Key": "stickiness.type"
        },
        {
            "Value": "86400",
            "Key": "stickiness.lb_cookie.duration_seconds"
        },
        {
            "Value": "0",
            "Key": "slow_start.duration_seconds"
        }
    ]
}

Следующий вывод включает атрибуты, если протокол HTTP или HTTPS, а тип целевого сервера lambda.

{
    "Attributes": [
        {
            "Value": "false",
            "Key": "lambda.multi_value_headers.enabled"
        }
    ]
}

Следующий вывод включает атрибуты, если протокол TCP, TLS, UDP или TCP_UDP.

{
    "Attributes": [
        {
            "Value": "false",
            "Key": "proxy_protocol_v2.enabled"
        },
        {
            "Value": "300",
            "Key": "deregistration_delay.timeout_seconds"
        }
    ]
}

Вывод

Атрибуты -> (список)

Информация об атрибутах целевой группы

(структура)

Информация об атрибуте целевой группы.

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

Имя атрибута.

Все балансировщики нагрузки поддерживают следующие атрибуты:

deregistration_delay.timeout_seconds - Время в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние дерегистрируемого целевого узла с draining на unused. Диапазон - от 0 до 3600 секунд. Значение по умолчанию - 300 секунд. Если целевой узел является функцией Lambda, этот атрибут не поддерживается.
stickiness.enabled - Указывает, включена ли привязка к целевому узлу. Значение - true или false. Значение по умолчанию - false.
stickiness.type - Указывает тип привязки. Возможные значения:
- lb_cookie и app_cookie для балансировщиков приложений.
- source_ip для балансировщиков сети.
- source_ip_dest_ip и source_ip_dest_ip_proto для балансировщиков шлюзов.

Балансировщики приложений и балансировщики сети поддерживают следующие атрибуты:

load_balancing.cross_zone.enabled - Указывает, включено ли кросс-зоновое балансирование. Значение - true, false или use_load_balancer_configuration. Значение по умолчанию - use_load_balancer_configuration.
target_group_health.dns_failover.minimum_healthy_targets.count - Минимальное количество работоспособных целевых узлов. Если количество работоспособных целевых узлов ниже этого значения, зона помечается как неработоспособная в DNS, и трафик маршрутизируется только в работоспособные зоны. Возможные значения - off или целое число от 1 до максимального количества целевых узлов. Значение по умолчанию - off.
target_group_health.dns_failover.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых узлов. Если процент работоспособных целевых узлов ниже этого значения, зона помечается как неработоспособная в DNS, и трафик маршрутизируется только в работоспособные зоны. Возможные значения - off или целое число от 1 до 100. Значение по умолчанию - off.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - Минимальное количество работоспособных целевых узлов. Если количество работоспособных целевых узлов ниже этого значения, трафик отправляется ко всем целевым узлам, включая неработоспособные. Возможные значения - от 1 до максимального количества целевых узлов. Значение по умолчанию - 1.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - Минимальный процент работоспособных целевых узлов. Если процент работоспособных целевых узлов ниже этого значения, трафик отправляется ко всем целевым узлам, включая неработоспособные. Возможные значения - off или целое число от 1 до 100. Значение по умолчанию - off.

Следующие атрибуты поддерживаются только если балансировщик является балансировщиком приложений, а целевой узел - экземпляром или IP-адресом:

load_balancing.algorithm.type - Алгоритм балансирования нагрузки определяет, как балансировщик нагрузки выбирает целевые узлы при маршрутизации запросов. Значение - round_robin, least_outstanding_requests или weighted_random. Значение по умолчанию - round_robin.
load_balancing.algorithm.anomaly_mitigation - Доступно только при включенном load_balancing.algorithm.type в режиме weighted_random. Указывает, включено ли смягчение аномалий. Значение - on или off. Значение по умолчанию - off.
slow_start.duration_seconds - Время в секундах, в течение которого новый зарегистрированный целевой узел получает увеличивающуюся долю трафика для группы целевых узлов. После истечения этого периода узел получает свою полную долю трафика. Диапазон - от 30 до 900 секунд (15 минут). Значение по умолчанию - 0 секунд (отключено).
stickiness.app_cookie.cookie_name - Указывает имя cookie на основе приложения. Имена, начинающиеся со следующих префиксов, запрещены: AWSALB, AWSALBAPP и AWSALBTG; они зарезервированы для использования балансировщиком.
stickiness.app_cookie.duration_seconds - Время в секундах, в течение которого запросы от клиента должны быть маршрутизированы к одному и тому же целевому узлу. После истечения этого периода cookie на основе приложения считается устаревшим. Диапазон - от 1 секунды до 1 недели (604800 секунд). Значение по умолчанию - 1 день (86400 секунд).
stickiness.lb_cookie.duration_seconds - Время в секундах, в течение которого запросы от клиента должны быть маршрутизированы к одному и тому же целевому узлу. После истечения этого периода сгенерированный балансировщиком cookie считается устаревшим. Диапазон - от 1 секунды до 1 недели (604800 секунд). Значение по умолчанию - 1 день (86400 секунд).

Следующий атрибут поддерживается только если балансировщик является балансировщиком приложений, а целевой узел - функцией Lambda:

lambda.multi_value_headers.enabled - Указывает, содержат ли обмен запросами и ответами между балансировщиком и функцией Lambda массивы значений или строки. Значение - true или false. Значение по умолчанию - false. Если значение равно false, и запрос содержит дублирующееся имя поля заголовка или ключ параметра запроса, балансировщик использует последнее значение, отправленное клиентом.

Следующие атрибуты поддерживаются только балансировщиками сети:

deregistration_delay.connection_termination.enabled - Указывает, завершает ли балансировщик соединения в конце тайм-аута дерегистрации. Значение - true или false. Для новых целевых групп UDP/TCP_UDP значение по умолчанию - true. В противном случае, значение по умолчанию - false.
preserve_client_ip.enabled - Указывает, включена ли сохранность IP-адресов клиента. Значение - true или false. По умолчанию отключено, если тип целевой группы - IP-адрес, и протокол целевой группы - TCP или TLS. В противном случае, значение по умолчанию включено. Сохранность IP-адресов клиента не может быть отключена для целевых групп UDP и TCP_UDP.
proxy_protocol_v2.enabled - Указывает, включен ли протокол Proxy Protocol версии 2. Значение - true или false. Значение по умолчанию - false.
target_health_state.unhealthy.connection_termination.enabled - Указывает, завершает ли балансировщик соединения с неработоспособными целевыми узлами. Значение - true или false. Значение по умолчанию - true. Этот атрибут не может быть включен для целевых групп UDP и TCP_UDP.
target_health_state.unhealthy.draining_interval_seconds - Время, в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние неработоспособного целевого узла с unhealthy.draining на unhealthy. Диапазон - от 0 до 360000 секунд. Значение по умолчанию - 0 секунд. Примечание: Этот атрибут можно настроить только когда target_health_state.unhealthy.connection_termination.enabled имеет значение false.

Следующие атрибуты поддерживаются только балансировщиками шлюзов:

target_failover.on_deregistration - Указывает, как балансировщик шлюзов обрабатывает существующие потоки при дерегистрации целевого узла. Возможные значения - rebalance и no_rebalance. Значение по умолчанию - no_rebalance. Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) нельзя устанавливать независимо. Установленное значение для обоих атрибутов должно быть одинаковым.
target_failover.on_unhealthy - Указывает, как балансировщик шлюзов обрабатывает существующие потоки при неработоспособности целевого узла. Возможные значения - rebalance и no_rebalance. Значение по умолчанию - no_rebalance. Два атрибута (target_failover.on_deregistration и target_failover.on_unhealthy) нельзя устанавливать независимо. Установленное значение для обоих атрибутов должно быть одинаковым.

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

Значение атрибута.