Spec-Zone.ru › AWS CLI v2

[ aws . codeguruprofiler ]

get-recommendations

Описание

Возвращает список объектов ` Recommendation https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html`__ содержащих рекомендации для группы профилирования на заданный период времени. Также возвращается список объектов ` Anomaly https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html`__ содержащих подробности об аномалиях, обнаруженных в группе профилирования за тот же период времени.

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

Синтаксис

  get-recommendations
--end-time <value>
[--locale <value>]
--profiling-group-name <value>
--start-time <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]

Параметры

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

Начальное время профиля, для которого требуется информация об анализе. Необходимо указать startTime и endTime. Формат указания — ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 1:15:02 по UTC.

--locale (строка)

Язык, используемый для предоставления анализа. Указывается с помощью одной из следующих BCP 47 кодов языка.

  • de-DE - Немецкий, Германия
  • en-GB - Английский, Великобритания
  • en-US - Английский, США
  • es-ES - Испанский, Испания
  • fr-FR - Французский, Франция
  • it-IT - Итальянский, Италия
  • ja-JP - Японский, Япония
  • ko-KR - Корейский, Республика Корея
  • pt-BR - Португальский, Бразилия
  • zh-CN - Китайский, Китай
  • zh-TW - Китайский, Тайвань

--profiling-group-name (строка)

Имя группы профилирования, для которой требуется информация об анализе.

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

Конечное время профиля, для которого требуется информация об анализе. Необходимо указать startTime и endTime. Формат указания — ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 1:15:02 по UTC.

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

Вывод

аномалии -> (список)

Список аномалий, обнаруженных анализом для данного профиля.

(структура)

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

инстансы -> (список)

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

(структура)

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

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

Конечная временная метка периода, в котором метрика отмечается как аномальная. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

id -> (строка)

Универсальный уникальный идентификатор (UUID) инстанса аномалии в метрике.

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

Начальная временная метка периода, в котором метрика отмечается как аномальная. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

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

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

type -> (строка)

Необязательная Positive или Negative обратная связь пользователя о том, полезна ли рекомендация.

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

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

frameName -> (строка)

Имя метода, который появляется в качестве фрейма в любом стеке в профиле.

threadStates -> (список)

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

(строка)

type -> (строка)

Тип, определяющий, как анализируется метрика для фрейма. Поддерживаемое значение AggregatedRelativeTotalTime - это агрегация значения метрики для одного фрейма, которая рассчитывается по всем появлениям фреймов в профиле.

reason -> (строка)

Причина, по которой метрика была отмечена как аномальная.

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

Конечная временная метка профиля, к которому относятся данные анализа. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

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

Начальная временная метка профиля, к которому относятся данные анализа. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

profilingGroupName -> (строка)

Имя группы профилирования, к которой относятся данные анализа.

recommendations -> (список)

Список рекомендаций, найденных анализом для данного профиля.

(структура)

Возможные улучшения, найденные при анализе данных профилирования.

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

Сколько различных мест в графе профиля вызвало совпадение.

allMatchesSum -> (вещественное число)

Какая часть общего количества выборок потенциально затронута.

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

Конечная временная метка профиля, использованного в этом анализе. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

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

Шаблон, распознанный анализом в профиле для данной рекомендации.

countersToAggregate -> (список)

Список различных счётчиков, использованных для определения совпадения.

(строка)

description -> (строка)

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

id -> (строка)

Универсальный уникальный идентификатор (UUID) этого шаблона.

name -> (строка)

Название этого шаблона.

resolutionSteps -> (строка)

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

targetFrames -> (список)

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

(список)

(строка)

thresholdPercent -> (вещественное число)

Процент времени, которое приложение тратит в одном методе, вызывающем рекомендацию. Процент времени совпадает с процентом от общего количества выборок, собранных во время анализа.

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

Начальная временная метка профиля, использованного в этом анализе. Указывается в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z соответствует 1 миллисекунде после 1 июня 2020 года в 13:15:02 по UTC.

topMatches -> (список)

Список совпадений с наибольшим влиянием.

(структура)

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

frameAddress -> (строка)

Расположение в графе профилирования, содержащее рекомендацию, найденную во время анализа.

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

Целевой фрейм, вызвавший совпадение.

thresholdBreachValue -> (вещественное число)

Значение в данных профиля, которое превысило порог рекомендации.

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

Spec-Zone.ru

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