Spec-Zone.ru › AWS CLI v2

[ aws . appmesh ]

describe-gateway-route

Описание

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

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

Синтаксис

  describe-gateway-route
--gateway-route-name <value>
--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]

Параметры

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

Имя маршрута шлюза для описания.

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

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

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

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

--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
  • текст
  • таблица
  • 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.

Вывод

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

Полное описание вашей шлюзовой маршрутизации.

gatewayRouteName -> (строка)

Название шлюзовой маршрутизации.

meshName -> (строка)

Название сервисной сетки, в которой находится ресурс.

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

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

arn -> (строка)

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

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

Маркер Unix-эпохи в секундах, обозначающий время создания ресурса.

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

Маркер Unix-эпохи в секундах, обозначающий время последнего обновления ресурса.

meshOwner -> (строка)

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

resourceOwner -> (строка)

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

uid -> (строка)

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

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

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

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

Технические характеристики шлюзовой маршрутизации.

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

Объект, представляющий технические характеристики маршрутизации gRPC шлюза.

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

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

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

Действие шлюзовой маршрутизации для переписывания.

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

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

defaultTargetHostname -> (строка)

Значение целевого имени хоста по умолчанию.

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

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

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

Номер порта целевого узла шлюзовой маршрутизации.

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

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

virtualServiceName -> (строка)

Имя виртуальной службы, куда направляется трафик.

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

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

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

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

exact -> (строка)

Точное имя хоста для сопоставления.

suffix -> (строка)

Указанный конечный набор символов имени хоста для сопоставления.

metadata -> (список)

Метаданные шлюзовой маршрутизации для сопоставления.

(структура)

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

invert -> (булево)

Укажите True, чтобы сопоставлять все, кроме критериев сопоставления. Значение по умолчанию — False.

match -> (структура помеченного союза)

Критерии для определения совпадения метаданных.

Примечание

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

exact -> (строка)

Точный заголовок метода для сопоставления.

prefix -> (строка)

Указанные начальные символы заголовка метода для сопоставления.

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

Объект, представляющий диапазон значений для сопоставления. Первый символ диапазона включен в диапазон, а последний — нет. Например, если указан диапазон 1-100, будут сопоставляться только значения 1-99.

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

Конец диапазона.

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

Начало диапазона.

regex -> (строка)

Регулярное выражение для сопоставления заголовка метода.

suffix -> (строка)

Указанные конечные символы заголовка метода для сопоставления.

name -> (строка)

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

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

Порт шлюзовой маршрутизации для сопоставления.

serviceName -> (строка)

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

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

Объект, представляющий технические характеристики маршрутизации HTTP/2 шлюза.

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

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

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

Действие шлюзовой маршрутизации для переписывания.

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

Имя хоста для переписывания.

defaultTargetHostname -> (строка)

Значение целевого имени хоста по умолчанию.

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

Путь для переписывания.

exact -> (строка)

Точный путь для переписывания.

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

Указанные начальные символы для переписывания.

defaultPrefix -> (строка)

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

value -> (строка)

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

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

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

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

Номер порта целевого узла шлюзовой маршрутизации.

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

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

virtualServiceName -> (строка)

Имя виртуальной службы, куда направляется трафик.

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

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

headers -> (список)

Заголовки клиентского запроса для сопоставления.

(структура)

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

invert -> (булево)

Укажите True, чтобы сопоставлять все, кроме критериев сопоставления. Значение по умолчанию — False.

match -> (структура помеченного союза)

Объект, представляющий метод и значение для сопоставления со значением заголовка, отправленным в запросе. Укажите один метод сопоставления.

Примечание

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

exact -> (строка)

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

prefix -> (строка)

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

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

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

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

Конец диапазона.

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

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя HTTP-заголовка в маршрутизации шлюза, который будет сопоставлен.

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

Имя хоста для сопоставления.

exact -> (строка)

Точное имя хоста для сопоставления.

suffix -> (строка)

Указанный конечный набор символов имени хоста для сопоставления.

method -> (строка)

Метод для сопоставления.

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

Путь для сопоставления.

exact -> (строка)

Точный путь для сопоставления.

regex -> (строка)

Регулярное выражение для сопоставления пути.

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

Номер порта для сопоставления.

prefix -> (строка)

Указывает путь для сопоставления запросов. Этот параметр всегда должен начинаться с /, что само по себе соответствует всем запросам к имени виртуальной службы. Также можно сопоставлять запросы на основе пути. Например, если имя вашей виртуальной службы — my-service.local, и вы хотите, чтобы маршрут соответствовал запросам на my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

Параметр запроса для сопоставления.

(структура)

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

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

Параметр запроса для сопоставления.

exact -> (строка)

Точный параметр запроса для сопоставления.

name -> (строка)

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

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

Объект, представляющий спецификацию маршрута шлюза HTTP.

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

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

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

Действие маршрута шлюза для переписывания.

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

Имя хоста для переписывания.

defaultTargetHostname -> (строка)

Значение имени хоста целевого ресурса по умолчанию.

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

Путь для переписывания.

exact -> (строка)

Точный путь для переписывания.

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

Указанные начальные символы для переписывания.

defaultPrefix -> (строка)

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

value -> (строка)

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

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

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

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

Номер порта целевого ресурса маршрута шлюза.

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

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

virtualServiceName -> (строка)

Имя виртуальной службы, к которой направляется трафик.

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

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

headers -> (список)

Заголовки запроса клиента для соответствия.

(структура)

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

invert -> (булево)

Укажите True для соответствия всем значениям, кроме заданных критериев. Значение по умолчанию — False.

match -> (меченый союз структур)

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

Примечание

Это структура меченого союза. Только один из следующих ключевых элементов верхнего уровня может быть задан: exact, prefix, range, regex, suffix.

exact -> (строка)

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

prefix -> (строка)

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

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

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

end -> (целое число с плавающей точкой)

Конец диапазона.

start -> (целое число с плавающей точкой)

Начало диапазона.

regex -> (строка)

Переданное клиентом значение должно включать указанные символы.

suffix -> (строка)

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

name -> (строка)

Имя HTTP-заголовка в маршруте шлюза, на котором будет производиться сопоставление.

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

Имя хоста для сопоставления.

exact -> (строка)

Точное имя хоста для сопоставления.

suffix -> (строка)

Указанные конечные символы имени хоста для сопоставления.

method -> (строка)

Метод для сопоставления.

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

Путь для сопоставления.

exact -> (строка)

Точный путь для сопоставления.

regex -> (строка)

Регулярное выражение для сопоставления пути.

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

Номер порта для сопоставления.

prefix -> (строка)

Указывает путь для сопоставления запросов. Этот параметр всегда должен начинаться с /, что само по себе соответствует всем запросам к имени виртуальной службы. Вы также можете использовать сопоставление для маршрутизации запросов по пути. Например, если имя вашей виртуальной службы — my-service.local, и вы хотите, чтобы маршрут соответствовал запросам к my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

Параметр запроса для сопоставления.

(структура)

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

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

Параметр запроса для сопоставления.

exact -> (строка)

Точный параметр запроса для сопоставления.

name -> (строка)

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

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

Порядок спецификации маршрутов шлюза.

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

Статус маршрута шлюза.

status -> (строка)

Текущий статус маршрута шлюза.

virtualGatewayName -> (строка)

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

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

Spec-Zone.ru

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