Spec-Zone.ru › AWS CLI v2

[ aws . appmesh ]

describe-virtual-router

Описание

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

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

Синтаксис

  describe-virtual-router
--mesh-name <value>
[--mesh-owner <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 владельца сервисной сетки. Если это не ваша учётная запись, это идентификатор учётной записи, которая поделилась сеткой с вашей. Дополнительная информация о совместном использовании сеток приведена в разделе Работа с общими сетками.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла параметров.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--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-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

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

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

Для описания виртуального маршрутизатора

Следующий describe-virtual-router пример возвращает подробности о заданном виртуальном маршрутизаторе.

aws appmesh describe-virtual-router \
    --mesh-name app1 \
    --virtual-router-name vrServiceB

Вывод:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563810546.59,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

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

Вывод

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

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

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 -> (структура)

Характеристики виртуального маршрутизатора.

listeners -> (список)

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

(структура)

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

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

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

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

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

protocol -> (строка)

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

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

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

status -> (строка)

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

virtualRouterName -> (строка)

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

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

Spec-Zone.ru

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