Spec-Zone.ru › AWS CLI v2

[ aws . globalaccelerator ]

describe-endpoint-group

Описание

Описывает группу конечных точек.

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

Синтаксис

  describe-endpoint-group
--endpoint-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]

Параметры

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

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

Следующий describe-endpoint-group пример извлекает подробности о группе конечных точек со следующими конечными точками: экземпляр Amazon EC2, ALB и NLB.

aws globalaccelerator describe-endpoint-group \
    --endpoint-group-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/ab88888example

Вывод:

{
    "EndpointGroup": {
        "TrafficDialPercentage": 100.0,
        "EndpointDescriptions": [
        {
            "Weight": 128,
            "EndpointId": "i-1234567890abcdef0"
        },
        {
            "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::012345678901: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 -> (строка)

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

Application Load Balancer может быть как внутренним, так и внешним.

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

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

HealthState -> (строка)

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

HealthReason -> (строка)

Возвращает пустой результат.

ClientIPPreservationEnabled -> (логическое значение)

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

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

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

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

TrafficDialPercentage -> (дробное число)

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

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

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

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

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

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

HealthCheckProtocol -> (строка)

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

HealthCheckPath -> (строка)

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

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

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

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

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

PortOverrides -> (список)

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

(структура)

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

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

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

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

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

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

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

Spec-Zone.ru

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