Spec-Zone.ru › AWS CLI v2

[ aws . application-signals ]

get-service

Описание

Возвращает информацию о службе, обнаруженной с помощью Application Signals.

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

Синтаксис

  get-service
--start-time <value>
--end-time <value>
--key-attributes <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]

Параметры

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

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

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

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

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

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

--key-attributes (карта)

Используйте это поле, чтобы указать, для какой службы вы хотите получить информацию. Вы должны указать по крайней мере атрибуты Type , Name и Environment.

Это карта строка-строка. Она может включать следующие поля.

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

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

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

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

Вывод

Сервис -> (структура)

Структура, содержащая информацию о сервисе.

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 — ID экземпляра Amazon EC2.
  • Host — имя хоста для всех типов платформ.

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

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

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

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

(карта)

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

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

MetricReferences -> (список)

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

(структура)

Эта структура содержит информацию об одной метрике CloudWatch, связанной с этим объектом, обнаруженном Application Signals.

Namespace -> (строка)

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

MetricType -> (строка)

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

Dimensions -> (список)

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

(структура)

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

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

Name -> (строка)

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

Value -> (строка)

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

MetricName -> (строка)

Имя метрики.

AccountId -> (строка)

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

LogGroupReferences -> (список)

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

  • "Type": "AWS::Resource"
  • "ResourceType": "AWS::Logs::LogGroup"
  • "Identifier": "*name-of-log-group* "

(карта)

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

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

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

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

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

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

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

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

LogGroupReferences -> (список)

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

  • "Type": "AWS::Resource"
  • "ResourceType": "AWS::Logs::LogGroup"
  • "Identifier": "*name-of-log-group* "

(карта)

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

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

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

Spec-Zone.ru

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