Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

list-insights-metric-data

Описание

Возвращает данные метрик Insights для трейлов, которые включили Insights. В запросе должны быть указаны параметры EventSource , EventName и InsightType.

Если параметр InsightType установлен в значение ApiErrorRateInsight, в запросе также должен быть указан параметр ErrorCode.

Ниже приведены доступные временные интервалы для ListInsightsMetricData. Каждый временной интервал включительно.

  • Точки данных с периодом 60 секунд (1 минута) доступны в течение 15 дней.
  • Точки данных с периодом 300 секунд (5 минут) доступны в течение 63 дней.
  • Точки данных с периодом 3600 секунд (1 час) доступны в течение 90 дней.

Доступ к операции API ListInsightsMetricData связан с действием cloudtrail:LookupEvents. Для использования этой операции необходимо иметь разрешения на выполнение действия cloudtrail:LookupEvents.

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

Синтаксис

  list-insights-metric-data
--event-source <value>
--event-name <value>
--insight-type <value>
[--error-code <value>]
[--start-time <value>]
[--end-time <value>]
[--period <value>]
[--data-type <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--event-source (строка)

Сервис Amazon Web Services, к которому был отправлен запрос, например, iam.amazonaws.com или s3.amazonaws.com.

--event-name (строка)

Название события, обычно API Amazon Web Services, по которому были зарегистрированы необычно высокие уровни активности.

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

Тип события CloudTrail Insights, который может быть ApiCallRateInsight или ApiErrorRateInsight. Тип Insights ApiCallRateInsight анализирует только операции управления записи, которые агрегируются за минуту по сравнению с базовым объемом API-вызовов. Тип Insights ApiErrorRateInsight анализирует вызовы API управления, которые приводят к кодам ошибок.

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

  • ApiCallRateInsight
  • ApiErrorRateInsight

--error-code (строка)

Требуется при условии, что параметр InsightType установлен в значение ApiErrorRateInsight.

Если возвращаются метрики для типа Insights ApiErrorRateInsight, это ошибка, для которой необходимо получить данные. Например, AccessDenied.

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

Указывает начальное время для временных рядов данных в формате UTC. Указанное значение включается; результаты включают точки данных со значением указанной метки времени.

По умолчанию — 90 дней до момента запроса.

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

Указывает конечное время для временных рядов данных в формате UTC. Указанное значение исключается; результаты включают точки данных до указанной метки времени.

По умолчанию — момент запроса.

--period (целое число)

Грань данных для извлечения в секундах. Допустимые значения — 60 , 300 и 3600. При указании других значений произойдет ошибка. По умолчанию — 3600 секунд.

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

Тип точек данных для возврата. Допустимые значения — NonZeroData и FillWithZeros. По умолчанию — NonZeroData.

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

  • FillWithZeros
  • NonZeroData

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

Максимальное количество точек данных для возврата. Допустимые значения — целые числа от 1 до 21600. Значение по умолчанию — 21600.

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

Возвращается, если все точки данных не могут быть возвращены в одном запросе. Например, из-за достижения MaxResults.

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

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

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

  • вкл
  • выкл
  • авто

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

Вывод

EventSource -> (строка)

Сервис Amazon Web Services, к которому был отправлен запрос, например, iam.amazonaws.com или s3.amazonaws.com.

EventName -> (строка)

Название события, обычно API Amazon Web Services, по которому были зарегистрированы необычно высокие уровни активности.

InsightType -> (строка)

Тип события CloudTrail Insights, который может быть ApiCallRateInsight или ApiErrorRateInsight. Тип Insights ApiCallRateInsight анализирует только операции управления записью, которые агрегируются за минуту по сравнению с базовым объемом API-вызовов. Тип Insights ApiErrorRateInsight анализирует вызовы API управления, которые приводят к кодам ошибок.

ErrorCode -> (строка)

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

Если возвращаются метрики для типа Insights ApiErrorRateInsight, это ошибка, для которой необходимо получить данные. Например, AccessDenied.

Timestamps -> (список)

Список меток времени с интервалами, соответствующими заданному временному периоду.

(метка времени)

Values -> (список)

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

(дробное значение)

NextToken -> (строка)

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

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

Spec-Zone.ru

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