Spec-Zone.ru › AWS CLI v2

[ aws . appmesh ]

describe-virtual-gateway

Описание

Описывает существующий виртуальный шлюз.

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

Синтаксис

  describe-virtual-gateway
--mesh-name <value>
[--mesh-owner <value>]
--virtual-gateway-name <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]

Параметры

--mesh-name (строка)

Имя сервисной сетки, в которой находится маршрут шлюза.

--mesh-owner (строка)

Идентификатор учетной записи AWS IAM владельца сервисной сетки. Если это не ваша учетная запись, это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сеток см. в разделе Работа с общими сетками.

--virtual-gateway-name (строка)

Имя виртуального шлюза, который нужно описать.

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

Вывод

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

Полное описание вашего виртуального шлюза.

meshName -> (строка)

Имя сервисной сетки, в которой находится виртуальный шлюз.

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

Объект, представляющий метаданные для ресурса.

arn -> (строка)

Полное Amazon Resource Name (ARN) для ресурса.

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

Временная метка Unix в секундах для момента создания ресурса.

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

Временная метка Unix в секундах для момента последнего обновления ресурса.

meshOwner -> (строка)

Идентификатор учетной записи AWS IAM владельца сервисной сетки. Если это не ваша учетная запись, это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сеток см. в разделе Работа с общими сетками.

resourceOwner -> (строка)

Идентификатор учетной записи AWS IAM владельца ресурса. Если это не ваша учетная запись, это идентификатор владельца сети или другой учетной записи, с которой сеть совмещена. Дополнительную информацию о совместном использовании сеток см. в разделе Работа с общими сетками.

uid -> (строка)

Уникальный идентификатор ресурса.

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

Версия ресурса. Ресурсы создаются с версией 1, и эта версия увеличивается каждый раз при их обновлении.

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

Спецификации виртуального шлюза.

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

Ссылка на объект, представляющий значения по умолчанию для бэкендов.

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

Ссылка на объект, представляющий политику клиента.

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

Ссылка на объект, представляющий политику клиента Transport Layer Security (TLS).

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

Ссылка на объект, представляющий сертификат Transport Layer Security (TLS) клиента виртуального шлюза.

Примечание

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

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

Объект, представляющий сертификат локального файла. Сертификат должен соответствовать определённым требованиям, и у вас должна быть включена авторизация прокси. Дополнительную информацию см. в разделе Transport Layer Security (TLS).

certificateChain -> (строка)

Цепочка сертификатов для сертификата.

privateKey -> (строка)

Закрытый ключ сертификата, хранящегося в файловой системе узла сети, на котором работает прокси.

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

Ссылка на объект, представляющий сертификат Secret Discovery Service клиента виртуального шлюза.

secretName -> (строка)

Ссылка на объект, представляющий имя секрета, запрошенного у поставщика Secret Discovery Service, представляющего материалы Transport Layer Security (TLS), такие как сертификат или цепочка сертификатов.

enforce -> (булево)

Применяется ли политика. По умолчанию значение True, если значение не указано.

ports -> (список)

Один или несколько портов, для которых применяется политика.

(целое число)

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

Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS).

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

Ссылка на объект, представляющий имена SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.

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

Объект, представляющий критерии для определения соответствия именам SAN.

exact -> (список)

Отправленные значения должны точно соответствовать заданным значениям.

(строка)

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

Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) удалённого узла.

Примечание

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

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

Ссылка на объект, представляющий контекст доверия Transport Layer Security (TLS) для сертификата Certificate Manager.

certificateAuthorityArns -> (список)

Один или несколько ARN Amazon Certificate Manager.

(строка)

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

Объект, представляющий контекст доверия Transport Layer Security (TLS) для локального файла.

certificateChain -> (строка)

Цепочка доверия сертификата, хранящегося в файловой системе виртуального узла, на котором работает прокси.

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

Ссылка на объект, представляющий контекст доверия Secret Discovery Service Transport Layer Security (TLS) виртуального шлюза.

secretName -> (строка)

Ссылка на объект, представляющий имя секрета для контекста доверия Secret Discovery Service Transport Layer Security (TLS) виртуального шлюза.

listeners -> (список)

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

(структура)

Объект, представляющий слушателя виртуального шлюза.

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

Информация о пуле подключений для слушателя виртуального шлюза.

Примечание

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

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

Объект, представляющий тип пула подключений.

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

Максимальное количество запросов, которые Envoy может одновременно обслуживать на хостах в кластере по верхнему уровню.

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

Объект, представляющий тип пула подключений.

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

Максимальное количество исходящих TCP-соединений, которые Envoy может одновременно установить со всеми хостами в кластере по верхнему уровню.

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

Количество переполненных запросов после max_connections, которые Envoy поместит в очередь в кластер по верхнему уровню.

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

Объект, представляющий тип пула подключений.

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

Максимальное количество запросов, которые Envoy может одновременно обслуживать на хостах в кластере по верхнему уровню.

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

Информация о проверке состояния для слушателя.

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

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

intervalMillis -> (длинное целое число)

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

path -> (строка)

Целевой путь для запроса проверки состояния. Это значение используется только в том случае, если указанный протокол — HTTP или HTTP/2. Для любого другого протокола это значение игнорируется.

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

Целевой порт для запроса проверки состояния. Этот порт должен соответствовать порту, определённому в PortMapping для слушателя.

protocol -> (строка)

Протокол для запроса проверки состояния. Если вы укажете grpc, то ваш сервис должен соответствовать протоколу проверки состояния GRPC.

timeoutMillis -> (длинное целое число)

Время ожидания ответа от проверки состояния в миллисекундах.

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

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

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

Информация о сопоставлении портов для слушателя.

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

Порт, используемый для сопоставления портов. Укажите один протокол.

protocol -> (строка)

Протокол, используемый для сопоставления портов.

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

Ссылка на объект, представляющий свойства Transport Layer Security (TLS) для слушателя.

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

Объект, представляющий сертификат Transport Layer Security (TLS).

Примечание

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

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

Ссылка на объект, представляющий сертификат Certificate Manager.

certificateArn -> (строка)

Amazon Resource Name (ARN) сертификата. Сертификат должен соответствовать определённым требованиям, и у вас должна быть включена авторизация прокси. Дополнительную информацию см. в разделе Transport Layer Security (TLS).

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

Ссылка на объект, представляющий сертификат локального файла.

certificateChain -> (строка)

Цепочка сертификатов для сертификата.

privateKey -> (строка)

Закрытый ключ сертификата, хранящегося в файловой системе узла сети, на котором работает прокси.

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

Ссылка на объект, представляющий сертификат Secret Discovery Service слушателя виртуального шлюза.

secretName -> (строка)

Ссылка на объект, представляющий имя секрета, запрошенного у поставщика Secret Discovery Service, представляющего материалы Transport Layer Security (TLS), такие как сертификат или цепочка сертификатов.

mode -> (строка)

Укажите один из следующих режимов.

  • STRICT — Слушатель принимает только подключения с включённым TLS.
  • PERMISSIVE — Слушатель принимает подключения с включённым или выключенным TLS.
  • DISABLED — Слушатель принимает только подключения без TLS.

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

Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS) слушателя виртуального шлюза.

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

Ссылка на объект, представляющий имена SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.

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

Объект, представляющий критерии для определения соответствия именам SAN.

exact -> (список)

Отправленные значения должны точно соответствовать заданным значениям.

(строка)

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

Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) удалённого узла.

Примечание

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

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

Объект, представляющий контекст доверия Transport Layer Security (TLS) для локального файла.

certificateChain -> (строка)

Цепочка доверия сертификата, хранящегося в файловой системе виртуального узла, на котором работает прокси.

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

Ссылка на объект, представляющий контекст доверия Secret Discovery Service Transport Layer Security (TLS) слушателя виртуального шлюза.

secretName -> (строка)

Ссылка на объект, представляющий имя секрета для контекста доверия Secret Discovery Service Transport Layer Security (TLS) слушателя виртуального шлюза.

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

Объект, представляющий информацию о регистрации.

accessLog -> (структура помеченных союзов)

Настройка журнала доступа.

Примечание

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

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

Объект файла для отправки журналов доступа виртуального шлюза.

format -> (структура помеченных союзов)

Указанный формат журналов доступа виртуального шлюза. Он может быть либо json_format, либо text_format.

Примечание

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

json -> (список)

(структура)

Объект, представляющий пары ключ-значение для JSON.

key -> (строка)

Указанный ключ для JSON.

value -> (строка)

Указанное значение для JSON.

text -> (строка)

path -> (строка)

Путь к файлу для записи журналов доступа. Можно использовать /dev/stdout для отправки журналов доступа в стандартный вывод и настроить ваш контейнер Envoy для использования драйвера журналов, такого как awslogs, чтобы экспортировать журналы доступа в службу хранения журналов, такую как Amazon CloudWatch Logs. Также можно указать путь в файловой системе контейнера Envoy для записи файлов на диск.

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

Текущий статус виртуального шлюза.

status -> (строка)

Текущий статус.

virtualGatewayName -> (строка)

Имя виртуального шлюза.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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