Spec-Zone.ru › AWS CLI v2

[ aws . application-signals ]

list-services

Описание

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

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

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

Синтаксис

  list-services
--start-time <value>
--end-time <value>
[--include-linked-accounts | --no-include-linked-accounts]
[--aws-account-id <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]

Параметры

--start-time (метка времени)

Начало временного интервала для получения информации. При использовании в сыром HTTP-запросе API, он форматируется как время эпохи в секундах. Например: 1698778057

Запрошенное начальное время будет округлено до ближайшего часа.

--end-time (метка времени)

Конец временного интервала для получения информации. При использовании в сыром HTTP-запросе API, он форматируется как время эпохи в секундах. Например: 1698778057

Запрошенное начальное время будет округлено до ближайшего часа.

--include-linked-accounts | --no-include-linked-accounts (логическое значение)

Если вы используете эту операцию в учетной записи мониторинга, укажите true, чтобы включить сервисы из исходных учетных записей в возвращаемых данных. </p>

--aws-account-id (строка)

Идентификатор учетной записи Amazon Web Services.

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

Вывод

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

Начало временного периода, к которому относится возвращаемая информация. При использовании API сырых HTTP-запросов он форматируется как время эпохи в секундах. Например: 1698778057

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

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

Конец временного периода, к которому относится возвращаемая информация. При использовании API сырых HTTP-запросов он форматируется как время эпохи в секундах. Например: 1698778057

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

ServiceSummaries -> (список)

Массив структур, где каждая структура содержит информацию о службе. Чтобы получить полную информацию о службе, используйте GetService.

(структура)

Эта структура содержит информацию об одной из ваших служб, обнаруженных Сигналами приложений.

KeyAttributes -> (словарь)

Это словарь «строка-строка», который помогает идентифицировать объекты, обнаруженные Сигналами приложений. Он может содержать следующие поля.

  • Type указывает тип объекта.
  • ResourceType определяет тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
  • Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
  • Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
  • Environment указывает место расположения этого объекта или к чему он принадлежит.

ключ -> (строка)

значение -> (строка)

AttributeMaps -> (список)

Эта структура содержит один или несколько словарей «строка-строка», которые помогают идентифицировать эту службу. Она может включать атрибуты платформы, атрибуты приложения и атрибуты телеметрии.

Атрибуты платформы содержат информацию о платформе службы.

  • PlatformType определяет платформу размещения.
  • EKS.Cluster — имя кластера Amazon EKS.
  • K8s.Cluster — имя самообслуживаемого кластера Kubernetes.
  • K8s.Namespace — имя пространства имен Kubernetes в кластерах Amazon EKS или Kubernetes.
  • K8s.Workload — имя рабочей нагрузки Kubernetes в кластерах Amazon EKS или Kubernetes.
  • K8s.Node — имя узла Kubernetes в кластерах Amazon EKS или Kubernetes.
  • K8s.Pod — имя поддода Kubernetes в кластерах Amazon EKS или Kubernetes.
  • EC2.AutoScalingGroup — имя группы автоматического масштабирования Amazon EC2.
  • EC2.InstanceId — идентификатор экземпляра Amazon EC2.
  • Host — имя хоста для всех типов платформ.

Атрибуты приложения содержат информацию об приложении.

  • AWS.Application — имя приложения в каталоге сервисов Amazon Web Services.
  • AWS.Application.ARN — ARN приложения в каталоге сервисов Amazon Web Services.

Атрибуты телеметрии содержат информацию о телеметрии.

  • Telemetry.SDK — отпечаток версии OpenTelemetry SDK для инструментированных сервисов.
  • Telemetry.Agent — отпечаток агента, используемого для сбора и отправки данных телеметрии.
  • Telemetry.Source Указывает точку приложения, где была собрана телеметрия, или указывает, что использовалось в качестве источника данных телеметрии.

(словарь)

ключ -> (строка)

значение -> (строка)

MetricReferences -> (список)

Массив структур, каждая из которых содержит информацию об одном метрике, связанной с этой службой.

(структура)

Эта структура содержит информацию об одной метрике CloudWatch, связанной с этим объектом, обнаруженным Сигналами приложений.

Namespace -> (строка)

Пространство имен метрики. Для получения дополнительной информации см. CloudWatchNamespaces.

MetricType -> (строка)

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

Dimensions -> (список)

Массив одного или нескольких измерений, которые дополнительно определяют метрику. Для получения дополнительной информации см. CloudWatchDimensions.

(структура)

Измерение — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из своих метрик, вы создаете новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId как имя измерения и фактический идентификатор экземпляра в качестве значения для этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, должны включать хотя бы один символ, отличный от пробела, и не могут начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в качестве части имен измерений.

Value -> (строка)

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

MetricName -> (строка)

Имя метрики.

AccountId -> (строка)

Идентификатор учетной записи Amazon Web Services.

NextToken -> (строка)

Включите это значение при следующем использовании этого API для получения следующего набора служб.

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

Spec-Zone.ru

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