описание-маршрута

Описание

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

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

Синтаксис

  describe-route
--mesh-name <value>
[--mesh-owner <value>]
--route-name <value>
--virtual-router-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 (строка)

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

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, подобные unix-подобным. Эти примеры нужно будет адаптировать к правилам цитирования вашей терминальной среды. Подробнее см. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для описания маршрута

Следующий describe-route пример возвращает сведения о заданном маршруте.

aws appmesh describe-route \
    --mesh-name app1 \
    --virtual-router-name vrServiceB \
    --route-name toVnServiceB-weighted

Вывод:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563811384.015,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 90
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 10
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

Дополнительную информацию см. в разделе Маршруты в руководстве пользователя AWS App Mesh.

Вывод

маршрут -> (структура)

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

имя_сети -> (строка)

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

метаданные -> (структура)

Соответствующие метаданные для маршрута.

arn -> (строка)

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

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

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

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

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

владелец_сети -> (строка)

владелец_ресурса -> (строка)

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

uid -> (строка)

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

версия -> (длинное целое число)

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

имя_маршрута -> (строка)

Имя маршрута.

спецификация -> (структура)

Спецификация маршрута.

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

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

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

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

weightedTargets -> (список)

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

(структура)

Объект, представляющий целевой узел и его относительный вес. Трафик распределяется между целевыми узлами в соответствии с их относительным весом. Например, целевой узел с относительным весом 50 получает в пять раз больше трафика, чем узел с относительным весом 10. Общий вес всех целевых узлов должен быть меньше или равен 100.

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

Целевой порт объекта с весом.

virtualNode -> (строка)

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

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

Относительный вес целевого узла с весом.

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

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

metadata -> (список)

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

(структура)

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

invert -> (булево значение)

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

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

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

Примечание

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

exact -> (строка)

Значение, отправленное клиентом, должно точно совпадать со значением.

prefix -> (строка)

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

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

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

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

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

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

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

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя маршрута.

methodName -> (строка)

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

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

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

serviceName -> (строка)

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

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

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

grpcRetryEvents -> (список)

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

(строка)

httpRetryEvents -> (список)

Укажите хотя бы одно из следующих значений.

server-error – Коды HTTP-статусов 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – Коды HTTP-статусов 502, 503 и 504
client-error – Код HTTP-статуса 409
stream-error – Повторить попытку при отказе от потока

(строка)

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

Максимальное количество попыток повтора.

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

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

tcpRetryEvents -> (список)

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

(строка)

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

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

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

Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время простоя соединения. Значение по умолчанию — none.

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

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

Объект, представляющий таймаут на запрос. Значение по умолчанию — 15 секунд. Если вы установите более высокий таймаут, убедитесь, что более высокое значение установлено для каждого ресурса App Mesh в диалоге. Например, если бэкенд виртуального узла использует виртуальный маршрутизатор для маршрутизации к другому виртуальному узлу, то таймаут должен быть больше 15 секунд для виртуального узла источника и назначения, а также для маршрута.

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

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

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

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

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

weightedTargets -> (список)

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

(структура)

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

Целевой порт объекта с весом.

virtualNode -> (строка)

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

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

Относительный вес целевого узла с весом.

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

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

headers -> (список)

Заголовки запроса клиента, которые нужно сопоставить.

(структура)

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

invert -> (булево значение)

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

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

Объект HeaderMatchMethod.

Примечание

exact -> (строка)

Значение, отправленное клиентом, должно точно совпадать со значением.

prefix -> (строка)

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

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

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

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

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

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

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

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

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

method -> (строка)

Метод запроса клиента для сопоставления. Укажите только один.

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

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

exact -> (строка)

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

regex -> (строка)

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

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

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

prefix -> (строка)

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

queryParameters -> (список)

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

(структура)

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

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

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

exact -> (строка)

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

name -> (строка)

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

scheme -> (строка)

Схема запроса клиента для сопоставления. Укажите только один. Применимо только для маршрутов HTTP2.

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

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

httpRetryEvents -> (список)

Укажите хотя бы одно из следующих значений.

server-error – Коды HTTP-статусов 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – Коды HTTP-статусов 502, 503 и 504
client-error – Код HTTP-статуса 409
stream-error – Повторить попытку при отказе от потока

(строка)

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

Максимальное количество попыток повтора.

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

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

tcpRetryEvents -> (список)

(строка)

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

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

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

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

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

unit -> (строка)

Единица измерения времени.

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

Количество единиц времени.

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

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

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

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

weightedTargets -> (список)

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

(структура)

Объект, представляющий цель и её относительный вес. Трафик распределяется между целями в соответствии с их относительным весом. Например, целевой объект с относительным весом 50 получает в пять раз больше трафика, чем целевой объект с относительным весом 10. Общий вес всех целей должен быть меньше или равен 100.

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

Порт целевого объекта.

virtualNode -> (строка)

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

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

Относительный вес целевого объекта.

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

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

headers -> (список)

Заголовки запроса клиента, по которым нужно произвести соответствие.

(структура)

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

invert -> (булево)

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

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

Объект HeaderMatchMethod.

Примечание

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

exact -> (строка)

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

prefix -> (строка)

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

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

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

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

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

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

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

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

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

method -> (строка)

Метод запроса клиента для сопоставления. Укажите только один.

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

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

exact -> (строка)

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

regex -> (строка)

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

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

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

prefix -> (строка)

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

queryParameters -> (список)

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

(структура)

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

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

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

exact -> (строка)

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

name -> (строка)

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

scheme -> (строка)

Схема запроса клиента для сопоставления. Укажите только одну. Применимо только для маршрутов HTTP2.

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

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

httpRetryEvents -> (список)

Укажите хотя бы одно из следующих значений.

server-error – HTTP коды статуса 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP коды статуса 502, 503 и 504
client-error – HTTP код статуса 409
stream-error – Повторная попытка при отклонении потока

(строка)

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

Максимальное количество попыток повтора.

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

Тайм-аут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

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

Число единиц времени.

tcpRetryEvents -> (список)

(строка)

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

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

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

Объект, представляющий тайм-аут бездействия. Тайм-аут бездействия ограничивает время бездействия соединения. Значение по умолчанию — none.

unit -> (строка)

Единица измерения времени.

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

Число единиц времени.

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

Объект, представляющий тайм-аут на запрос. Значение по умолчанию — 15 секунд. Если вы устанавливаете больший тайм-аут, убедитесь, что более высокое значение установлено для каждого ресурса App Mesh в разговоре. Например, если бэкенд виртуального узла использует поставщика виртуального маршрутизатора для маршрутизации к другому виртуальному узлу, то тайм-аут должен быть больше 15 секунд для виртуального узла источника и назначения, а также для маршрута.

unit -> (строка)

Единица измерения времени.

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

Число единиц времени.

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

Приоритет маршрута. Маршруты сопоставляются на основе указанного значения, где 0 — наивысший приоритет.

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

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

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

Действие, которое нужно выполнить при совпадении с маршрутом.

weightedTargets -> (список)

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

(структура)

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

Порт целевого объекта.

virtualNode -> (строка)

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

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

Относительный вес целевого объекта.

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

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

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

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

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

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

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

unit -> (строка)

Единица измерения времени.

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

Число единиц времени.

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

Статус маршрута.

status -> (строка)

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

virtualRouterName -> (строка)

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

END_OF_DOCUMENT_MARKER