Spec-Zone.ru › AWS CLI v2

[ aws . globalaccelerator ]

list-endpoint-groups

Описание

Список групп конечных точек, связанных с шлюзом.

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

list-endpoint-groups это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: EndpointGroups

Синтаксис

  list-endpoint-groups
--listener-arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--listener-arn (строка)

Amazon Resource Name (ARN) шлюза.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное значение JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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.

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

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

aws globalaccelerator --region us-west-2 list-endpoint-groups \
    --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234

Вывод:

{
    "EndpointGroups": [
        {
            "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab88888example",
            "EndpointGroupRegion": "eu-central-1",
            "EndpointDescriptions": [],
            "TrafficDialPercentage": 100.0,
            "HealthCheckPort": 80,
            "HealthCheckProtocol": "TCP",
            "HealthCheckIntervalSeconds": 30,
            "ThresholdCount": 3
        }
        {
            "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab99999example",
            "EndpointGroupRegion": "us-east-1",
            "EndpointDescriptions": [],
            "TrafficDialPercentage": 50.0,
            "HealthCheckPort": 80,
            "HealthCheckProtocol": "TCP",
            "HealthCheckIntervalSeconds": 30,
            "ThresholdCount": 3
        }
    ]
}

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

Вывод

EndpointGroups -> (список)

Список групп конечных точек, связанных с слушателем.

(структура)

Сложный тип для группы конечных точек. В одной зоне Amazon Web Services может быть только одна группа конечных точек для определенного слушателя.

EndpointGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы конечных точек.

EndpointGroupRegion -> (строка)

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

EndpointDescriptions -> (список)

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

(структура)

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

EndpointId -> (строка)

Идентификатор конечной точки. Если конечная точка — балансировщик сети или балансировщик приложений, это Идентификатор ресурса Amazon (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, это значение определяет путь ping, который Global Accelerator использует для назначения на конечных точках для проверок работоспособности. Значение по умолчанию — косой черта (/).

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

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

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

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

PortOverrides -> (список)

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

(структура)

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

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

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

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

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

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

NextToken -> (строка)

Токен для следующего набора результатов. Этот токен вы получаете из предыдущего вызова.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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