Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

получить-группу-целей

Описание

Получает информацию о заданной группе целей.

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

Синтаксис

  get-target-group
--target-group-identifier <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-identifier (строка)

Идентификатор или 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
  • текст
  • таблица
  • 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 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 в Руководстве пользователя AWS CLI.

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

Для получения информации о группе целей

Следующий get-target-group пример получает информацию о заданной группе целей, которая имеет тип целевого объекта INSTANCE.

aws vpc-lattice get-target-group \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Вывод:

{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "createdAt": "2023-05-06T04:41:04.122Z",
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "lastUpdatedAt": "2023-05-06T04:41:04.122Z",
    "name": "my-target-group",
    "serviceArns": [
        "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE"
    ],
    "status": "ACTIVE",
    "type": "INSTANCE"
}

Для получения дополнительной информации см. раздел «Группы целей» в Руководстве пользователя Amazon VPC Lattice.

Вывод

arn -> (строка)

Amazon Resource Name (ARN) группы целей.

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

Настройки группы целей.

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

Настройки проверки работоспособности. Не поддерживается, если тип группы целей является LAMBDA или ALB .

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

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

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

Приблизительное время в секундах между проверками работоспособности отдельной цели. Диапазон составляет от 5 до 300 секунд. По умолчанию 30 секунд.

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

Время в секундах ожидания, прежде чем цель будет считаться неработоспособной. Диапазон составляет от 1 до 120 секунд. По умолчанию 5 секунд.

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

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

matcher -> (структура помеченного объединения)

Коды для использования при проверке успешного ответа от цели.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: httpCode.

httpCode -> (строка)

Код HTTP для использования при проверке успешного ответа от цели.

path -> (строка)

Путь назначения для проверок работоспособности по целям. Если версия протокола является HTTP/1.1 или HTTP/2 , укажите допустимый URI (например, /path?query ). Путь по умолчанию — / . Проверки работоспособности не поддерживаются, если версия протокола является gRPC , однако вы можете выбрать HTTP/1.1 или HTTP/2 и указать допустимый URI.

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

Порт, используемый при выполнении проверок работоспособности целей. Значение по умолчанию — порт, на котором цель получает трафик.

protocol -> (строка)

Протокол, используемый при выполнении проверок работоспособности целей. Возможные протоколы — HTTP и HTTPS . По умолчанию — HTTP .

protocolVersion -> (строка)

Версия протокола, используемая при выполнении проверок работоспособности целей. Возможные версии протоколов — HTTP1 и HTTP2 .

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

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

ipAddressType -> (строка)

Тип IP-адреса, используемого для группы целей. Поддерживается только если тип группы целей — IP . По умолчанию — IPV4 .

lambdaEventStructureVersion -> (строка)

Версия структуры событий, которую получает ваша функция Lambda. Поддерживается только если тип группы целей — LAMBDA . По умолчанию — V1 .

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

Порт, на котором слушают цели. Для HTTP по умолчанию 80. Для HTTPS по умолчанию 443. Не поддерживается, если тип группы целей — LAMBDA .

protocol -> (строка)

Протокол для маршрутизации трафика к целям. По умолчанию используется протокол группы целей. Не поддерживается, если тип группы целей — LAMBDA .

protocolVersion -> (строка)

Версия протокола. По умолчанию — HTTP1 . Не поддерживается, если тип группы целей — LAMBDA .

vpcIdentifier -> (строка)

Идентификатор VPC. Не поддерживается, если тип группы целей — LAMBDA .

createdAt -> (метка времени)

Дата и время создания группы целей в формате ISO-8601.

failureCode -> (строка)

Код ошибки.

failureMessage -> (строка)

Сообщение об ошибке.

id -> (строка)

Идентификатор группы целей.

lastUpdatedAt -> (метка времени)

Дата и время последнего обновления группы целей в формате ISO-8601.

name -> (строка)

Название группы целей.

serviceArns -> (список)

Amazon Resource Names (ARN) сервиса.

(строка)

status -> (строка)

Статус.

type -> (строка)

Тип группы целей.

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

Spec-Zone.ru

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