[ aws . cloudwatch ]
describe-alarm-history
Описание
Получает историю указанной сигнализации. Можно фильтровать результаты по диапазону дат или типу элементов. Если имя сигнализации не указано, возвращается история всех метрических сигнализаций или всех составных сигнализаций.
CloudWatch сохраняет историю сигнализации, даже если вы её удалили.
Для использования этой операции и возврата информации о составной сигнализации вы должны быть авторизованы с разрешением cloudwatch:DescribeAlarmHistory, которое ограничено *. Вы не можете вернуть информацию о составных сигнализациях, если ваше разрешение cloudwatch:DescribeAlarmHistory имеет более узкую область действия.
См. также: Документация API AWS
describe-alarm-history — это страничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить страничное отображение, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с страничным отображением аргумент --query должен извлекать данные из результатов следующих выражений запроса: AlarmHistoryItems
Синтаксис
describe-alarm-history
[--alarm-name <value>]
[--alarm-types <value>]
[--history-item-type <value>]
[--start-date <value>]
[--end-date <value>]
[--scan-by <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]
Параметры
--alarm-name (строка)
--alarm-types (список)
Используйте этот параметр, чтобы указать, хотите ли вы, чтобы операция возвращала метрические или составные сигналізации. Если вы опустите этот параметр, будут возвращены только метрические сигналізации.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
CompositeAlarm
MetricAlarm
--history-item-type (строка)
Тип истории сигнализаций для извлечения.
Возможные значения:
ConfigurationUpdateStateUpdateAction
--start-date (отметка времени)
--end-date (отметка времени)
--scan-by (строка)
Указывает, возвращать ли самую новую или самую старую историю сигнализаций в первую очередь. Укажите TimestampDescending, чтобы сначала вернуть самую новую историю событий, и укажите TimestampAscending, чтобы сначала вернуть самую старую историю.
Возможные значения:
TimestampDescendingTimestampAscending
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала страничного отображения. Это NextToken из предыдущего усеченного ответа.
Примеры использования см. в разделе «Страничное отображение» в Руководстве пользователя AWS CLI.
--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
- 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. Подробнее см. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для получения истории сигнализации
В следующем примере используется команда describe-alarm-history для получения истории сигнализации Amazon CloudWatch с именем «myalarm»:
aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate
Вывод:
{
"AlarmHistoryItems": [
{
"Timestamp": "2014-04-09T18:59:06.442Z",
"HistoryItemType": "StateUpdate",
"AlarmName": "myalarm",
"HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}",
"HistorySummary": "Alarm updated from ALARM to OK"
},
{
"Timestamp": "2014-04-09T18:59:05.805Z",
"HistoryItemType": "StateUpdate",
"AlarmName": "myalarm",
"HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}",
"HistorySummary": "Alarm updated from OK to ALARM"
}
]
}
Вывод
AlarmHistoryItems -> (список)
История сигнализаций в формате JSON.
(структура)
Представляет историю конкретной сигнализации.
AlarmName -> (строка)
AlarmType -> (строка)
Timestamp -> (отметка времени)
HistoryItemType -> (строка)
HistorySummary -> (строка)
HistoryData -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.