Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

modify-target-group

Описание

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

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

Синтаксис

  modify-target-group
--target-group-arn <value>
[--health-check-protocol <value>]
[--health-check-port <value>]
[--health-check-path <value>]
[--health-check-enabled | --no-health-check-enabled]
[--health-check-interval-seconds <value>]
[--health-check-timeout-seconds <value>]
[--healthy-threshold-count <value>]
[--unhealthy-threshold-count <value>]
[--matcher <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) группы целевых экземпляров.

--health-check-protocol (строка)

Протокол, используемый балансировщиком нагрузки при проверке работоспособности целевых экземпляров. Для Application Load Balancers по умолчанию используется HTTP. Для Network Load Balancers и Gateway Load Balancers по умолчанию используется TCP. Протокол TCP не поддерживается для проверок работоспособности, если протокол целевой группы — HTTP или HTTPS. Он поддерживается для проверок работоспособности только если протокол целевой группы — TCP, TLS, UDP или TCP_UDP. Протоколы GENEVE, TLS, UDP и TCP_UDP не поддерживаются для проверок работоспособности.

Возможные значения:

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

--health-check-port (строка)

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

--health-check-path (строка)

[Проверки работоспособности HTTP/HTTPS] Цель проверок работоспособности целевых экземпляров.

[Версия протокола HTTP1 или HTTP2] Путь для проверки. По умолчанию — /.

[Версия протокола GRPC] Путь кастомного метода проверки работоспособности в формате /package.service/method. По умолчанию — /Amazon Web Services.ALB/healthcheck.

--health-check-enabled | --no-health-check-enabled (логическое значение)

Указывает, включены ли проверки работоспособности.

--health-check-interval-seconds (целое число)

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

--health-check-timeout-seconds (целое число)

[Проверки работоспособности HTTP/HTTPS] Время в секундах, в течение которого отсутствие ответа означает проваленную проверку работоспособности.

--healthy-threshold-count (целое число)

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

--unhealthy-threshold-count (целое число)

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

--matcher (структура)

[Проверки работоспособности HTTP/HTTPS] HTTP- или gRPC-коды, используемые при проверке успешного ответа от целевого экземпляра. Для групп целевых экземпляров с протоколом TCP, TCP_UDP, UDP или TLS диапазон составляет 200-599. Для групп целевых экземпляров с протоколом HTTP или HTTPS диапазон составляет 200-499. Для групп целевых экземпляров с протоколом GENEVE диапазон составляет 200-399.

HttpCode -> (строка)

Для Application Load Balancers вы можете указать значения от 200 до 499, значение по умолчанию — 200. Вы можете указать несколько значений (например, «200,202») или диапазон значений (например, «200-299»).

Для Network Load Balancers вы можете указать значения от 200 до 599, значение по умолчанию — 200-399. Вы можете указать несколько значений (например, «200,202») или диапазон значений (например, «200-299»).

Для Gateway Load Balancers это должно быть «200–399».

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

GrpcCode -> (строка)

Вы можете указать значения от 0 до 99. Вы можете указать несколько значений (например, «0,1») или диапазон значений (например, «0-5»). Значение по умолчанию — 12.

Сокращенная запись:

HttpCode=string,GrpcCode=string

Формат JSON:

{
  "HttpCode": "string",
  "GrpcCode": "string"
}

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

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

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

Следующий пример изменяет конфигурацию проверок работоспособности, используемых для оценки работоспособности целевых экземпляров для указанной группы целевых экземпляров. Обратите внимание, что из-за того, как CLI обрабатывает запятые, необходимо заключить диапазон для параметра --matcher в одинарные кавычки вместо двойных.

aws elbv2 modify-target-group \
    --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f \
    --health-check-protocol HTTPS \
    --health-check-port 443 \
    --matcher HttpCode='200,299'

Вывод:

{
    "TargetGroups": [
        {
            "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f",
            "TargetGroupName": "my-https-targets",
            "Protocol": "HTTPS",
            "Port": 443,
            "VpcId": "vpc-3ac0fb5f",
            "HealthCheckProtocol": "HTTPS",
            "HealthCheckPort": "443",
            "HealthCheckEnabled": true,
            "HealthCheckIntervalSeconds": 30,
            "HealthCheckTimeoutSeconds": 5,
            "HealthyThresholdCount": 5,
            "UnhealthyThresholdCount": 2,
            "Matcher": {
                "HttpCode": "200,299"
            },
            "LoadBalancerArns": [
                "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
            ],
            "TargetType": "instance",
            "ProtocolVersion": "HTTP1",
            "IpAddressType": "ipv4"
        }
    ]
}

Дополнительную информацию см. в разделе «Группы целевых экземпляров» в Руководстве по балансировщикам нагрузки приложений.

Вывод

TargetGroups -> (список)

Информация о изменённой целевой группе.

(структура)

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

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) целевой группы.

TargetGroupName -> (строка)

Имя целевой группы.

Protocol -> (строка)

Протокол для маршрутизации трафика к целевым экземплярам.

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

Порт, на котором слушают целевые экземпляры. Этот параметр не используется, если целевой экземпляр — функция Lambda.

VpcId -> (строка)

Идентификатор VPC для целевых экземпляров.

HealthCheckProtocol -> (строка)

Протокол для подключения к целевому экземпляру. Протоколы GENEVE, TLS, UDP и TCP_UDP не поддерживаются для проверок работоспособности.

HealthCheckPort -> (строка)

Порт для подключения к целевому экземпляру.

HealthCheckEnabled -> (булево)

Указывает, включены ли проверки работоспособности.

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

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

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

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

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

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

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

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

HealthCheckPath -> (строка)

Назначение для проверок работоспособности на целевых экземплярах.

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

HTTP или gRPC коды, используемые для проверки успешного ответа от целевого экземпляра.

HttpCode -> (строка)

Для балансировщиков приложений можно указать значения от 200 до 499, по умолчанию 200. Можно указать несколько значений (например, “200,202”) или диапазон значений (например, “200-299”).

Для балансировщиков сети можно указать значения от 200 до 599, по умолчанию 200-399. Можно указать несколько значений (например, “200,202”) или диапазон значений (например, “200-299”).

Для балансировщиков шлюза это должно быть “200–399”.

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

GrpcCode -> (строка)

Можно указать значения от 0 до 99. Можно указать несколько значений (например, “0,1”) или диапазон значений (например, “0-5”). Значение по умолчанию 12.

LoadBalancerArns -> (список)

Идентификатор ресурса Amazon (ARN) балансировщика нагрузки, который маршрутизирует трафик в эту целевую группу. Каждая целевая группа может быть использована только с одним балансировщиком нагрузки.

(строка)

TargetType -> (строка)

Тип целевого экземпляра, который необходимо указать при регистрации целевых экземпляров в этой целевой группе. Возможные значения: instance (регистрация целевых экземпляров по ID экземпляра), ip (регистрация целевых экземпляров по IP-адресу), lambda (регистрация одной функции Lambda в качестве целевого экземпляра) или alb (регистрация одного балансировщика приложений в качестве целевого экземпляра).

ProtocolVersion -> (строка)

[Протокол HTTP/HTTPS] Версия протокола. Возможные значения: GRPC, HTTP1 и HTTP2.

IpAddressType -> (строка)

Тип IP-адреса. Значение по умолчанию: ipv4.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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