Spec-Zone.ru › AWS CLI v2

[ aws . globalaccelerator ]

update-endpoint-group

Описание

Обновление группы конечных точек. Ресурс должен быть валидным и активным при добавлении его в качестве конечной точки.

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

Синтаксис

  update-endpoint-group
--endpoint-group-arn <value>
[--endpoint-configurations <value>]
[--traffic-dial-percentage <value>]
[--health-check-port <value>]
[--health-check-protocol <value>]
[--health-check-path <value>]
[--health-check-interval-seconds <value>]
[--threshold-count <value>]
[--port-overrides <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]

Параметры

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

Amazon Resource Name (ARN) группы конечных точек.

--endpoint-configurations (список)

Список объектов конечных точек. Ресурс должен быть валидным и активным при добавлении его в качестве конечной точки.

(структура)

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

EndpointId -> (строка)

Идентификатор конечной точки. Если конечная точка — это Network Load Balancer или Application Load Balancer, это Amazon Resource Name (ARN) ресурса. Если конечная точка — это Elastic IP адрес, это ID выделения Elastic IP адреса. Для экземпляров Amazon EC2 это ID экземпляра EC2. Ресурс должен быть валидным и активным при добавлении его в качестве конечной точки.

Для конечных точек между учётными записями это должен быть ARN ресурса.

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

Вес, связанный с конечной точкой. При добавлении весов к конечным точкам Global Accelerator маршрутизирует трафик, основываясь на указанных пропорциях. Например, вы можете задать веса конечных точек 4, 5, 5 и 6 (сумма=20). Результатом будет то, что 4/20 вашего трафика, в среднем, маршрутизируется на первую конечную точку, 5/20 маршрутизируется как на вторую, так и на третью конечные точки, и 6/20 маршрутизируется на последнюю конечную точку. Дополнительную информацию см. в разделе Веса конечных точек в Руководстве разработчика Global Accelerator.

ClientIPPreservationEnabled -> (булево)

Указывает, включена ли сохранённость IP-адреса клиента для конечной точки. Значение равно true или false. По умолчанию для конечных точек Application Load Balancer оно равно true.

Если значение установлено в true, IP-адрес клиента сохраняется в заголовке запроса X-Forwarded-For при прохождении трафика к приложениям на конечной точке, обрамлённой ускорителем.

Сохранение IP-адреса клиента поддерживается в определённых регионах Amazon Web Services для конечных точек, являющихся Application Load Balancers, экземплярами Amazon EC2 и Network Load Balancers с группами безопасности. ВАЖНО: Сохранение IP-адреса клиента нельзя использовать с Network Load Balancers с TLS-листенарами.

Дополнительную информацию см. в разделе Сохранение IP-адресов клиентов в Global Accelerator в Руководстве разработчика Global Accelerator.

AttachmentArn -> (строка)

Amazon Resource Name (ARN) прикрепления между учётными записями, которое определяет конечные точки (ресурсы), которые можно добавить к ускорителям и принципалам, имеющим разрешение на добавление конечных точек.

Краткая запись:

EndpointId=string,Weight=integer,ClientIPPreservationEnabled=boolean,AttachmentArn=string ...

Синтаксис JSON:

[
  {
    "EndpointId": "string",
    "Weight": integer,
    "ClientIPPreservationEnabled": true|false,
    "AttachmentArn": "string"
  }
  ...
]

--traffic-dial-percentage (число с плавающей запятой)

Процент трафика, направляемого в регион Amazon Web Services. Дополнительный трафик распределяется по другим группам конечных точек для этого листенара.

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

Значение по умолчанию — 100.

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

Порт, который Global Accelerator использует для проверки состояния конечных точек, входящих в эту группу конечных точек. Порт по умолчанию — порт листенара, с которым связана эта группа конечных точек. Если порт листенара является списком портов, Global Accelerator использует первый порт в списке.

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

Протокол, который Global Accelerator использует для проверки состояния конечных точек, входящих в эту группу конечных точек. Значение по умолчанию — TCP.

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

  • TCP
  • HTTP
  • HTTPS

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

Если протокол HTTP/S, то это указывает путь, являющийся местом назначения для целей проверки состояния. Значение по умолчанию — слэш (/).

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

Время — 10 секунд или 30 секунд — между каждой проверкой состояния конечной точки. Значение по умолчанию — 30.

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

Количество последовательных проверок состояния, необходимых для перевода состояния здоровой конечной точки в состояние нездоровой или для перевода нездоровой конечной точки в состояние здоровой. Значение по умолчанию — 3.

--port-overrides (список)

Переопределение определённых портов листенара, используемых для маршрутизации трафика конечным точкам, входящим в эту группу конечных точек. Например, вы можете создать переопределение порта, при котором листенар получает трафик пользователя на портах 80 и 443, но ваш ускоритель маршрутизирует этот трафик на порты 1080 и 1443 соответственно на конечных точках.

Дополнительную информацию см. в разделе Переопределение портов листенара в Руководстве разработчика Global Accelerator.

(структура)

Переопределение определённых портов листенара, используемых для маршрутизации трафика конечным точкам, входящим в группу конечных точек. Например, вы можете создать переопределение порта, при котором листенар получает трафик пользователя на портах 80 и 443, но ваш ускоритель маршрутизирует этот трафик на порты 1080 и 1443 соответственно на конечных точках.

Дополнительную информацию см. в разделе Переопределение портов листенара в Руководстве разработчика Global Accelerator.

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

Порт листенара, который вы хотите сопоставить с определённым портом конечной точки. Это порт, на который трафик пользователя прибывает в Global Accelerator.

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

Порт конечной точки, на который вы хотите сопоставить порт листенара. Это порт на конечной точке, например, Application Load Balancer или экземпляре Amazon EC2.

Краткая запись:

ListenerPort=integer,EndpointPort=integer ...

Синтаксис JSON:

[
  {
    "ListenerPort": integer,
    "EndpointPort": integer
  }
  ...
]

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

Для обновления группы конечных точек

В следующем update-endpoint-group примере добавляются три конечные точки в группу конечных точек: Elastic IP адрес, ALB и NLB.

aws globalaccelerator update-endpoint-group \
    --endpoint-group-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example \
    --endpoint-configurations \
        EndpointId=eipalloc-eip01234567890abc,Weight=128 \
        EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz,Weight=128 \
        EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs,Weight=128

Вывод:

{
    "EndpointGroup": {
        "TrafficDialPercentage": 100,
        "EndpointDescriptions": [
            {
                "Weight": 128,
                "EndpointId": "eip01234567890abc"
            },
            {
                "Weight": 128,
                "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz"
            },
            {
                "Weight": 128,
                "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs"
            }
        ],
        "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg",
        "EndpointGroupRegion": "us-east-1"
    }
}

Дополнительную информацию см. в разделе Группы конечных точек в AWS Global Accelerator в Руководстве разработчика AWS Global Accelerator.

Вывод

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

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

EndpointGroupArn -> (строка)

Amazon Resource Name (ARN) группы конечных точек.

EndpointGroupRegion -> (строка)

Регион Amazon Web Services, в котором расположена группа конечных точек.

EndpointDescriptions -> (список)

Список объектов конечных точек.

(структура)

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

EndpointId -> (строка)

Идентификатор конечной точки. Если конечная точка является балансировщиком сети или приложения, это Amazon Resource Name (ARN) ресурса. Если конечная точка — это Elastic IP-адрес, это идентификатор выделения Elastic IP-адреса. Для экземпляров Amazon EC2 это идентификатор экземпляра EC2.

Балансировщик приложений может быть внутренним или внешним.

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

Вес, связанный с конечной точкой. При добавлении весов к конечным точкам Global Accelerator маршрутизирует трафик в соответствии с заданными пропорциями. Например, вы можете задать веса конечных точек 4, 5, 5 и 6 (сумма=20). В результате 4/20 вашего трафика в среднем направляется на первую конечную точку, 5/20 — на вторую и третью конечные точки, а 6/20 — на последнюю конечную точку. Дополнительную информацию см. в разделе "Веса конечных точек" в руководстве разработчика Global Accelerator.

HealthState -> (строка)

Состояние работоспособности конечной точки.

HealthReason -> (строка)

Возвращает пустое значение.

ClientIPPreservationEnabled -> (булево)

Указывает, включено ли сохранение адреса IP-клиента для конечной точки. Значение равно true или false. По умолчанию значение равно true для конечных точек балансировщиков приложений.

Если значение установлено в true, IP-адрес клиента сохраняется в заголовке запроса X-Forwarded-For при перемещении трафика к приложениям на конечной точке, обрамлённой акселератором.

Сохранение IP-адреса клиента поддерживается в определённых регионах Amazon Web Services для конечных точек, являющихся балансировщиками приложений, экземплярами Amazon EC2 и балансировщиками сети с группами безопасности. ВАЖНО: сохранение IP-адреса клиента нельзя использовать с балансировщиками сети с TLS-слушателями.

Дополнительную информацию см. в разделе «Сохранение адресов IP-клиентов в Global Accelerator» в руководстве разработчика Global Accelerator.

TrafficDialPercentage -> (вещественное число)

Процент трафика, который необходимо отправить в регион Amazon Web Services. Дополнительный трафик распределяется по другим группам конечных точек для этого слушателя.

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

Значение по умолчанию равно 100.

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

Порт, который Global Accelerator использует для проверки работоспособности конечных точек, которые являются частью этой группы конечных точек.

Порт по умолчанию — это порт слушателя, к которому привязана эта группа конечных точек. Если порт слушателя является списком, Global Accelerator использует первый указанный порт в списке портов.

HealthCheckProtocol -> (строка)

Протокол, который Global Accelerator использует для проверки работоспособности конечных точек, которые являются частью этой группы конечных точек. Значение по умолчанию — TCP.

HealthCheckPath -> (строка)

Если протокол — HTTP/S, это значение задаёт путь пинга, который Global Accelerator использует для назначения конечных точек для проверки работоспособности. Значение по умолчанию — слэш (/).

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

Время между проверками работоспособности каждой конечной точки — 10 или 30 секунд. Значение по умолчанию — 30.

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

Количество последовательных проверок работоспособности, необходимых для изменения состояния здоровой конечной точки на нездоровую или нездоровой конечной точки на здоровую. Значение по умолчанию — 3.

PortOverrides -> (список)

Позволяет переопределить порты назначения, используемые для маршрутизации трафика на конечную точку. Использование переопределения порта позволяет сопоставить список внешних портов назначения (к которым пользователи отправляют трафик) со списком внутренних портов назначения, на которые вы хотите, чтобы конечная точка приложения получала трафик.

(структура)

Переопределяет определённые порты слушателя, используемые для маршрутизации трафика на конечные точки, которые являются частью группы конечных точек. Например, вы можете создать переопределение порта, в котором слушатель получает трафик пользователей на портах 80 и 443, но ваш акселератор маршрутизирует этот трафик на порты 1080 и 1443 соответственно на конечных точках.

Дополнительную информацию см. в разделе «Переопределение портов слушателя» в руководстве разработчика Global Accelerator.

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

Порт слушателя, который вы хотите сопоставить с определённым портом конечной точки. Это порт, на который трафик пользователей поступает в Global Accelerator.

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

Порт конечной точки, которому вы хотите сопоставить порт слушателя. Это порт на конечной точке, например, балансировщике приложений или экземпляре Amazon EC2.

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

Spec-Zone.ru

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