Spec-Zone.ru › AWS CLI v2

[ aws . appmesh ]

list-virtual-services

Описание

Возвращает список существующих виртуальных служб в сети служб.

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

list-virtual-services является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: virtualServices

Синтаксис

  list-virtual-services
--mesh-name <value>
[--mesh-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 владельца сети служб. Если идентификатор не ваш, то это идентификатор учетной записи, которая поделилась сетью с вашей учетной записью. Дополнительную информацию о совместном использовании сетей см. в разделе Работа с общими сетями.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой точки начать постраничную обработку. Это значение NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервисов.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

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

Используемый регион. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки config/env.

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

Для перечисления виртуальных служб

Следующий пример list-virtual-services перечисляет все виртуальные службы в указанной сети служб.

aws appmesh list-virtual-services \
    --mesh-name app1

Вывод:

{
    "virtualServices": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local",
            "meshName": "app1",
            "virtualServiceName": "serviceA.svc.cluster.local"
        },
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local",
            "meshName": "app1",
            "virtualServiceName": "serviceB.svc.cluster.local"
        }
    ]
}

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

Вывод

nextToken -> (строка)

Значение nextToken, которое необходимо включить в будущий запрос ListVirtualServices. Когда результаты запроса ListVirtualServices превышают limit, вы можете использовать это значение для получения следующей страницы результатов. Это значение null, когда больше результатов для возврата нет.

virtualServices -> (список)

Список существующих виртуальных служб для указанной сети служб.

(структура)

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

arn -> (строка)

Полное имя Amazon Resource Name (ARN) виртуальной службы.

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

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

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

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

meshName -> (строка)

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

meshOwner -> (строка)

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

resourceOwner -> (строка)

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

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

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

virtualServiceName -> (строка)

Имя виртуальной службы.

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

Spec-Zone.ru

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