Spec-Zone.ru › AWS CLI v2

[ aws . pi ]

get-performance-analysis-report

Описание

Получает отчёт, включая идентификатор отчёта, статус, временные данные и выводы с рекомендациями. Статус отчёта может быть RUNNING , SUCCEEDED или FAILED . Выводы включают поля description и recommendation.

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

Синтаксис

  get-performance-analysis-report
--service-type <value>
--identifier <value>
--analysis-report-id <value>
[--text-format <value>]
[--accept-language <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]

Параметры

--service-type (строка)

Сервис Amazon Web Services, для которого Performance Insights вернёт метрики. Допустимое значение — RDS .

Возможные значения:

  • RDS
  • DOCDB

--identifier (строка)

Неизменяемый идентификатор источника данных, уникальный для региона Amazon Web Services. Performance Insights собирает метрики из этого источника данных. В консоли идентификатор отображается как ResourceID . При вызове DescribeDBInstances, идентификатор возвращается как DbiResourceId .

Для использования экземпляра базы данных в качестве источника данных укажите его значение DbiResourceId. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

--analysis-report-id (строка)

Уникальный идентификатор созданного отчёта анализа. Например, report-12345678901234567

--text-format (строка)

Указывает формат текста в отчёте. Доступны варианты PLAIN_TEXT или MARKDOWN . Значение по умолчанию — plain text .

Возможные значения:

  • PLAIN_TEXT
  • MARKDOWN

--accept-language (строка)

Язык текста в отчёте. Язык по умолчанию — EN_US (английский).

Возможные значения:

  • EN_US

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

Получение отчёта анализа производительности

Следующий get-performance-analysis-report пример получает отчёт анализа производительности для базы данных db-abcdefg123456789 с идентификатором отчёта report-0d99cc91c4422ee61. Ответ содержит статус отчёта, идентификатор, временные данные и выводы.

aws pi get-performance-analysis-report \
    --service-type RDS \
    --identifier db-abcdefg123456789 \
    --analysis-report-id report-0d99cc91c4422ee61

Вывод:

{
    "AnalysisReport": {
        "Status": "Succeeded",
        "ServiceType": "RDS",
        "Identifier": "db-abcdefg123456789",
        "StartTime": 1680583486.584,
        "AnalysisReportId": "report-0d99cc91c4422ee61",
        "EndTime": 1680587086.584,
        "CreateTime": 1680587087.139,
        "Insights": [
            ... (Condensed for space)
       ]
    }
}

Дополнительную информацию об отчётах анализа производительности см. в разделе Анализ производительности базы данных за период времени в руководстве пользователя Amazon RDS и в разделе Анализ производительности базы данных за период времени в руководстве пользователя Amazon Aurora.

Вывод

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

Резюме отчета об анализе производительности, созданного за определенный период.

AnalysisReportId -> (строка)

Название отчета об анализе.

Identifier -> (строка)

Уникальный идентификатор отчета об анализе.

ServiceType -> (строка)

Список тегов сервиса Amazon Web Services, для которого Performance Insights возвращает метрики. Допустимые значения:

  • RDS
  • DOCDB

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

Время создания отчета об анализе.

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

Начальное время анализа в отчете.

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

Конечное время анализа в отчете.

Status -> (строка)

Статус созданного отчета об анализе.

Insights -> (список)

Список выявленных инсайтов в отчете об анализе.

(структура)

Возвращает список выявленных проблем производительности.

InsightId -> (строка)

Уникальный идентификатор инсайта. Например, insight-12345678901234567.

InsightType -> (строка)

Тип инсайта. Например, HighDBLoad, HighCPU или DominatingSQLs.

Context -> (строка)

Указывает, является ли инсайт причинным или корреляционным.

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

Начальное время инсайта. Например, 2018-10-30T00:00:00Z.

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

Конечное время инсайта. Например, 2018-10-30T00:00:00Z.

Severity -> (строка)

Уровень важности инсайта. Допустимые значения: Low, Medium или High.

SupportingInsights -> (список)

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

(структура)

Возвращает список выявленных проблем производительности.

InsightId -> (строка)

Уникальный идентификатор инсайта. Например, insight-12345678901234567.

InsightType -> (строка)

Тип инсайта. Например, HighDBLoad, HighCPU или DominatingSQLs.

Context -> (строка)

Указывает, является ли инсайт причинным или корреляционным.

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

Начальное время инсайта. Например, 2018-10-30T00:00:00Z.

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

Конечное время инсайта. Например, 2018-10-30T00:00:00Z.

Severity -> (строка)

Уровень важности инсайта. Допустимые значения: Low, Medium или High.

Description -> (строка)

Описание инсайта. Например: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

Recommendations -> (список)

Список рекомендаций для инсайта. Например, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.

(структура)

Список рекомендаций для инсайта.

RecommendationId -> (строка)

Уникальный идентификатор рекомендации.

RecommendationDescription -> (строка)

Подробности рекомендации для решения проблемы производительности. Например, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

InsightData -> (список)

Список объектов данных, содержащих метрики и ссылки из временного диапазона при генерации инсайта.

(структура)

Список объектов данных, предоставляющих подробности о исходных метриках. Этот поле используется для определения метрики PI для отображения инсайта. Этот тип данных также включает статические значения метрик для инсайта, рассчитанные и включенные в текст и аннотации на диаграмме загрузки БД.

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

Это поле определяет метрику Performance Insights для отображения инсайта. Поле name относится к метрике Performance Insights.

Metric -> (строка)

Метрика Performance Insights.

DisplayName -> (строка)

Имя метрики Performance Insights.

Dimensions -> (карта)

Карта измерений, содержащая измерения для этого раздела.

key -> (строка)

value -> (строка)

Filter -> (карта)

Фильтр для метрики Performance Insights.

key -> (строка)

value -> (строка)

Value -> (двойное)

Значение метрики. Например, 9 для db.load.avg.

BaselineData -> (список)

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

(структура)

Список объектов данных, предоставляющих подробности о исходных метриках. Этот поле используется для определения метрики PI для отображения инсайта. Этот тип данных также включает статические значения метрик для инсайта, рассчитанные и включенные в текст и аннотации на диаграмме загрузки БД.

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

Это поле определяет метрику Performance Insights для отображения инсайта. Поле name относится к метрике Performance Insights.

Metric -> (строка)

Метрика Performance Insights.

DisplayName -> (строка)

Имя метрики Performance Insights.

Dimensions -> (карта)

Карта измерений, содержащая измерения для этого раздела.

key -> (строка)

value -> (строка)

Filter -> (карта)

Фильтр для метрики Performance Insights.

key -> (строка)

value -> (строка)

Value -> (двойное)

Значение метрики. Например, 9 для db.load.avg.

Description -> (строка)

Описание инсайта. Например: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

Recommendations -> (список)

Список рекомендаций для инсайта. Например, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.

(структура)

Список рекомендаций для инсайта.

RecommendationId -> (строка)

Уникальный идентификатор рекомендации.

RecommendationDescription -> (строка)

Подробности рекомендации для решения проблемы производительности. Например, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

InsightData -> (список)

Список объектов данных, содержащих метрики и ссылки из временного диапазона при генерации инсайта.

(структура)

Список объектов данных, предоставляющих подробности о исходных метриках. Этот поле используется для определения метрики PI для отображения инсайта. Этот тип данных также включает статические значения метрик для инсайта, рассчитанные и включенные в текст и аннотации на диаграмме загрузки БД.

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

Это поле определяет метрику Performance Insights для отображения инсайта. Поле name относится к метрике Performance Insights.

Metric -> (строка)

Метрика Performance Insights.

DisplayName -> (строка)

Имя метрики Performance Insights.

Dimensions -> (карта)

Карта измерений, содержащая измерения для этого раздела.

key -> (строка)

value -> (строка)

Filter -> (карта)

Фильтр для метрики Performance Insights.

key -> (строка)

value -> (строка)

Value -> (двойное)

Значение метрики. Например, 9 для db.load.avg.

BaselineData -> (список)

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

(структура)

Список объектов данных, предоставляющих подробности о исходных метриках. Этот поле используется для определения метрики PI для отображения инсайта. Этот тип данных также включает статические значения метрик для инсайта, рассчитанные и включенные в текст и аннотации на диаграмме загрузки БД.

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

Это поле определяет метрику Performance Insights для отображения инсайта. Поле name относится к метрике Performance Insights.

Metric -> (строка)

Метрика Performance Insights.

DisplayName -> (строка)

Имя метрики Performance Insights.

Dimensions -> (карта)

Карта измерений, содержащая измерения для этого раздела.

key -> (строка)

value -> (строка)

Filter -> (карта)

Фильтр для метрики Performance Insights.

key -> (строка)

value -> (строка)

Value -> (двойное)

Значение метрики. Например, 9 для db.load.avg.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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