describe-virtual-node
Описание
Описывает существующий виртуальный узел.
См. также: Документация API AWS
Синтаксис
describe-virtual-node
--mesh-name <value>
[--mesh-owner <value>]
--virtual-node-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 (строка)
--virtual-node-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.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запрошение параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров, необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Для описания виртуального узла
Следующий describe-virtual-node пример возвращает подробную информацию о заданном виртуальном узле.
aws appmesh describe-virtual-node \
--mesh-name app1 \
--virtual-node-name vnServiceBv1
Вывод:
{
"virtualNode": {
"meshName": "app1",
"metadata": {
"arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
"createdAt": 1563810019.874,
"lastUpdatedAt": 1563810019.874,
"uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"version": 1
},
"spec": {
"backends": [],
"listeners": [
{
"portMapping": {
"port": 80,
"protocol": "http"
}
}
],
"serviceDiscovery": {
"dns": {
"hostname": "serviceBv1.svc.cluster.local"
}
}
},
"status": {
"status": "ACTIVE"
},
"virtualNodeName": "vnServiceBv1"
}
}
Дополнительную информацию см. в разделе Виртуальные узлы в руководстве пользователя AWS App Mesh.
Вывод
virtualNode -> (структура)
Полное описание вашего виртуального узла.
meshName -> (строка)
metadata -> (структура)
Сопутствующие метаданные для виртуального узла.
arn -> (строка)
createdAt -> (метка времени)
lastUpdatedAt -> (метка времени)
meshOwner -> (строка)
resourceOwner -> (строка)
uid -> (строка)
version -> (целое число)
spec -> (структура)
Характеристики виртуального узла.
backendDefaults -> (структура)
Ссылка на объект, представляющий значения по умолчанию для бэкендов.
clientPolicy -> (структура)
Ссылка на объект, представляющий политику клиента.
tls -> (структура)
Ссылка на объект, представляющий политику клиента TLS (Transport Layer Security).
certificate -> (структура помеченного союза)
Ссылка на объект, представляющий сертификат TLS клиента.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:file, sds.file -> (структура)
Объект, представляющий сертификат локального файла. Сертификат должен соответствовать определенным требованиям, и у вас должна быть включена авторизация прокси. Для получения дополнительной информации см. TLS (Transport Layer Security).
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат клиента TLS Secret Discovery Service.
secretName -> (строка)
enforce -> (булево)
True, если значение не указано.ports -> (список)
Один или несколько портов, для которых применяется политика.
(целое число)
validation -> (структура)
Ссылка на объект, представляющий контекст проверки TLS.
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки TLS. Если вы не указываете SAN на завершающем узле сетки, прокси Envoy для данного узла не проверяет SAN в сертификате клиента-партнера. Если вы не указываете SAN на исходном узле сетки, SAN в сертификате, предоставленном завершающим узлом, должен совпадать с конфигурацией обнаружения сервисов сетевого узла. Поскольку сертификаты, предоставленные SPIRE, имеют SPIFFE-ID в качестве имени, вы должны установить SAN, поскольку имя не соответствует имени службы обнаружения.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Передаваемые значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченного союза)
Ссылка на место получения цепочки доверия при проверке сертификата TLS партнера.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий доверие контекста проверки TLS для сертификата Certificate Manager.
certificateAuthorityArns -> (список)
Один или несколько ARN ACM.
(строка)
file -> (структура)
Объект, представляющий доверие контекста проверки TLS для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий доверие контекста проверки TLS Secret Discovery Service.
secretName -> (строка)
backends -> (список)
Бэкенды, которым виртуальный узел должен отправлять исходящий трафик.
(структура помеченного союза)
Объект, представляющий бэкенды, которым виртуальный узел должен отправлять исходящий трафик.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:virtualService.virtualService -> (структура)
Указывает виртуальную службу, используемую в качестве бэкенда.
clientPolicy -> (структура)
Ссылка на объект, представляющий политику клиента для бэкенда.
tls -> (структура)
Ссылка на объект, представляющий политику клиента TLS (Transport Layer Security).
certificate -> (структура помеченного союза)
Ссылка на объект, представляющий сертификат TLS клиента.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:file, sds.file -> (структура)
Объект, представляющий сертификат локального файла. Сертификат должен соответствовать определенным требованиям, и у вас должна быть включена авторизация прокси. Для получения дополнительной информации см. TLS (Transport Layer Security).
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат клиента TLS Secret Discovery Service.
secretName -> (строка)
enforce -> (булево)
True, если значение не указано.ports -> (список)
Один или несколько портов, для которых применяется политика.
(целое число)
validation -> (структура)
Ссылка на объект, представляющий контекст проверки TLS.
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки TLS. Если вы не указываете SAN на завершающем узле сетки, прокси Envoy для данного узла не проверяет SAN в сертификате клиента-партнера. Если вы не указываете SAN на исходном узле сетки, SAN в сертификате, предоставленном завершающим узлом, должен совпадать с конфигурацией обнаружения сервисов сетевого узла. Поскольку сертификаты, предоставленные SPIRE, имеют SPIFFE-ID в качестве имени, вы должны установить SAN, поскольку имя не соответствует имени службы обнаружения.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Передаваемые значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченного союза)
Ссылка на место получения цепочки доверия при проверке сертификата TLS партнера.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий доверие контекста проверки TLS для сертификата Certificate Manager.
certificateAuthorityArns -> (список)
Один или несколько ARN ACM.
(строка)
file -> (структура)
Объект, представляющий доверие контекста проверки TLS для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий доверие контекста проверки TLS Secret Discovery Service.
secretName -> (строка)
virtualServiceName -> (строка)
listeners -> (список)
Слушатель, от которого виртуальный узел ожидает входящего трафика. Можно указать одного слушателя.
(структура)
Объект, представляющий слушателя виртуального узла.
connectionPool -> (структура помеченных объединений)
Информация о пуле подключений для слушателя.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:grpc, http, http2, tcp.grpc -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
http -> (структура)
Объект, представляющий тип пула подключений.
maxConnections -> (целое число)
maxPendingRequests -> (целое число)
max_connections Envoy будет помещать в очередь в кластер вверх по потоку.http2 -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
tcp -> (структура)
Объект, представляющий тип пула подключений.
maxConnections -> (целое число)
healthCheck -> (структура)
Информация о проверке работоспособности для слушателя.
healthyThreshold -> (целое число)
intervalMillis -> (длинное целое)
path -> (строка)
port -> (целое число)
protocol -> (строка)
grpc, то ваш сервис должен соответствовать протоколу проверки работоспособности GRPC.timeoutMillis -> (длинное целое)
unhealthyThreshold -> (целое число)
outlierDetection -> (структура)
Информация об обнаружении выбросов для слушателя.
baseEjectionDuration -> (структура)
Базовая продолжительность, на которую узел выводится из работы.
unit -> (строка)
value -> (длинное целое)
interval -> (структура)
Интервал времени между анализом исключения.
unit -> (строка)
value -> (длинное целое)
maxEjectionPercent -> (целое число)
maxServerErrors -> (длинное целое)
5xx ошибок, необходимых для исключения.portMapping -> (структура)
Информация о сопоставлении портов для слушателя.
port -> (целое число)
protocol -> (строка)
timeout -> (структура помеченных объединений)
Объект, представляющий таймауты для различных протоколов.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:grpc, http, http2, tcp.grpc -> (структура)
Объект, представляющий типы таймаутов.
idle -> (структура)
Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время, в течение которого соединение может быть неактивным. Значение по умолчанию — none.
unit -> (строка)
value -> (длинное целое)
perRequest -> (структура)
Объект, представляющий таймаут на запрос. Значение по умолчанию — 15 секунд. Если вы установите более высокое значение таймаута, убедитесь, что более высокое значение установлено для каждого ресурса App Mesh в разговоре. Например, если бэкенд виртуального узла использует виртуальный маршрутизатор для маршрутизации к другому виртуальному узлу, то таймаут должен быть больше 15 секунд для исходного и целевого виртуального узла и маршрута.
unit -> (строка)
value -> (длинное целое)
http -> (структура)
Объект, представляющий типы таймаутов.
idle -> (структура)
Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время, в течение которого соединение может быть неактивным. Значение по умолчанию — none.
unit -> (строка)
value -> (длинное целое)
perRequest -> (структура)
Объект, представляющий таймаут на запрос. Значение по умолчанию — 15 секунд. Если вы установите более высокое значение таймаута, убедитесь, что более высокое значение установлено для каждого ресурса App Mesh в разговоре. Например, если бэкенд виртуального узла использует виртуальный маршрутизатор для маршрутизации к другому виртуальному узлу, то таймаут должен быть больше 15 секунд для исходного и целевого виртуального узла и маршрута.
unit -> (строка)
value -> (длинное целое)
http2 -> (структура)
Объект, представляющий типы таймаутов.
idle -> (структура)
Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время, в течение которого соединение может быть неактивным. Значение по умолчанию — none.
unit -> (строка)
value -> (длинное целое)
perRequest -> (структура)
Объект, представляющий таймаут на запрос. Значение по умолчанию — 15 секунд. Если вы установите более высокое значение таймаута, убедитесь, что более высокое значение установлено для каждого ресурса App Mesh в разговоре. Например, если бэкенд виртуального узла использует виртуальный маршрутизатор для маршрутизации к другому виртуальному узлу, то таймаут должен быть больше 15 секунд для исходного и целевого виртуального узла и маршрута.
unit -> (строка)
value -> (длинное целое)
tcp -> (структура)
Объект, представляющий типы таймаутов.
idle -> (структура)
Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время, в течение которого соединение может быть неактивным. Значение по умолчанию — none.
unit -> (строка)
value -> (длинное целое)
tls -> (структура)
Ссылка на объект, представляющий свойства Transport Layer Security (TLS) для слушателя.
certificate -> (структура помеченных объединений)
Ссылка на объект, представляющий сертификат Transport Layer Security (TLS) слушателя.
Примечание
Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий сертификат Certificate Manager.
certificateArn -> (строка)
file -> (структура)
Ссылка на объект, представляющий сертификат локального файла.
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат Secret Discovery Service слушателя.
secretName -> (строка)
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 -> (структура)
Ссылка на объект, представляющий контекст валидации Transport Layer Security (TLS) Secret Discovery Service слушателя.
secretName -> (строка)
logging -> (структура)
Информация о входящих и исходящих записях доступа для виртуального узла.
accessLog -> (структура помеченного объединения)
Настройка журнала доступа для виртуального узла.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:file.file -> (структура)
Объект файла, в который отправляются журналы доступа виртуального узла.
format -> (структура помеченного объединения)
Указанный формат журналов. Формат может быть json_format или text_format.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:json, text.json -> (список)
(структура)
Объект, представляющий пары ключ-значение для JSON.
key -> (строка)
value -> (строка)
text -> (строка)
path -> (строка)
Путь к файлу для записи журналов доступа. Можно использовать /dev/stdout для отправки журналов доступа в стандартный вывод и настроить контейнер Envoy для использования драйвера журналов, например awslogs, чтобы экспортировать журналы доступа в службу хранения журналов, такую как Amazon CloudWatch Logs. Также можно указать путь в файловой системе контейнера Envoy для записи файлов на диск.
Примечание
Процесс Envoy должен иметь права записи в указанный здесь путь. В противном случае Envoy не сможет корректно запуститься.serviceDiscovery -> (структура помеченного объединения)
Информация о службе обнаружения для виртуального узла. Если ваш виртуальный узел не ожидает входящего трафика, вы можете опустить этот параметр. Если вы укажете listener, тогда вы должны указать информацию о службе обнаружения.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня:awsCloudMap, dns.awsCloudMap -> (структура)
Указывает информацию Cloud Map для виртуального узла.
attributes -> (список)
Карта строк, содержащая атрибуты со значениями, которые можно использовать для фильтрации экземпляров по любому пользовательскому атрибуту, который вы указали при регистрации экземпляра. Будут возвращены только экземпляры, соответствующие всем указанным парам ключ/значение.
(структура)
Объект, представляющий информацию об атрибуте Cloud Map для вашего виртуального узла.
Примечание
Cloud Map недоступен в регионе eu-south-1.key -> (строка)
value -> (строка)
ipPreference -> (строка)
namespaceName -> (строка)
serviceName -> (строка)
dns -> (структура)
Указывает информацию DNS для виртуального узла.
hostname -> (строка)
ipPreference -> (строка)
responseType -> (строка)
status -> (структура)
Текущий статус виртуального узла.
status -> (строка)
virtualNodeName -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.