get-alarms
Описание
Возвращает информацию о настроенных сигнализациях. Укажите имя сигнализации в запросе, чтобы получить информацию о конкретной сигнализации, или укажите имя отслеживаемого ресурса, чтобы получить информацию обо всех сигнализациях для конкретного ресурса.
Сигнализация используется для мониторинга одного метрического показателя для одного из ваших ресурсов. Когда условие метрического показателя выполняется, сигнализация может уведомить вас по электронной почте, SMS-сообщению и значком, отображаемым на консоли Amazon Lightsail. Дополнительную информацию см. в разделе Сигнализации в Amazon Lightsail.
См. также: Документацию API AWS
Синтаксис
get-alarms
[--alarm-name <value>]
[--page-token <value>]
[--monitored-resource-name <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]
Параметры
--alarm-name (строка)
Имя сигнализации.
Укажите имя сигнализации, чтобы получить информацию о конкретной сигнализации.
--page-token (строка)
Токен для перехода к следующей странице результатов вашего запроса.
Чтобы получить токен страницы, выполните начальный запрос GetAlarms. Если ваши результаты постраничены, ответ вернёт токен следующей страницы, который вы можете указать как токен страницы в последующем запросе.
--monitored-resource-name (строка)
Имя ресурса Lightsail, отслеживаемого сигнализацией.
Укажите имя отслеживаемого ресурса, чтобы получить информацию обо всех сигнализациях для конкретного ресурса.
--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.
Вывод
alarms -> (список)
Массив объектов, описывающих сигнализации.
(структура)
Описание сигнализации.
Сигнализация — это способ мониторинга метрик ресурсов Lightsail. Дополнительную информацию см. в разделе Сигнализации в Amazon Lightsail.
name -> (строка)
arn -> (строка)
createdAt -> (метка времени)
location -> (структура)
Объект, содержащий информацию о местоположении сигнализации.
availabilityZone -> (строка)
us-east-2a (регистрозависимый).regionName -> (строка)
resourceType -> (строка)
supportCode -> (строка)
monitoredResourceInfo -> (структура)
Объект, содержащий информацию о ресурсе, отслеживаемом сигнализацией.
arn -> (строка)
name -> (строка)
resourceType -> (строка)
Тип ресурса Lightsail отслеживаемого ресурса.
Инстансы, балансировщики нагрузки и реляционные базы данных — единственные ресурсы Lightsail, которые в настоящее время могут отслеживаться с помощью сигнализаций.
comparisonOperator -> (строка)
evaluationPeriods -> (целое число)
period -> (целое число)
threshold -> (двойное значение)
datapointsToAlarm -> (целое число)
treatMissingData -> (строка)
Определяет, как сигнализация обрабатывает отсутствующие точки данных.
Сигнализация может обрабатывать отсутствующие данные следующим образом:
-
breaching- Предполагается, что отсутствующие данные не находятся в пределах порога. Отсутствующие данные учитываются при подсчёте случаев, когда метрика не находится в пределах порога. -
notBreaching- Предполагается, что отсутствующие данные находятся в пределах порога. Отсутствующие данные не учитываются при подсчёте случаев, когда метрика не находится в пределах порога. -
ignore- Игнорировать отсутствующие данные. Сохраняет текущее состояние сигнализации. -
missing- Отсутствующие данные обрабатываются как отсутствующие.
statistic -> (строка)
Статистика для метрики, связанной с сигнализацией.
Доступны следующие статистики:
-
Minimum- Наименьшее значение, наблюдаемое в течение указанного периода. Используйте это значение, чтобы определить низкий объём активности вашего приложения. -
Maximum- Наибольшее значение, наблюдаемое в течение указанного периода. Используйте это значение, чтобы определить большой объём активности вашего приложения. -
Sum- Все значения, предоставленные для соответствующей метрики, складываются вместе. Вы можете использовать эту статистику, чтобы определить общий объём метрики. -
Average- Значение Sum / SampleCount в течение указанного периода. Сравнивая эту статистику с минимальными и максимальными значениями, вы можете определить полный объём метрики и то, насколько близко среднее использование находится к минимальным и максимальным значениям. Это сравнение поможет вам понять, когда следует увеличивать или уменьшать свои ресурсы. -
SampleCount- Подсчёт, или количество, точек данных, используемых для статистического расчёта.
metricName -> (строка)
state -> (строка)
Текущее состояние сигнализации.
Сигнализация имеет следующие возможные состояния:
-
ALARM- Метрика находится вне определённого порога. -
INSUFFICIENT_DATA- Сигнализация только что началась, метрика недоступна или недостаточно данных доступно для определения состояния сигнализации. -
OK- Метрика находится в пределах определённого порога.
unit -> (строка)
contactProtocols -> (список)
Протоколы связи для сигнализации, такие как Email, SMS (сообщения) или оба.
(строка)
notificationTriggers -> (список)
Состояния сигнализации, которые запускают уведомление.
(строка)
notificationEnabled -> (логическое значение)
nextPageToken -> (строка)
Токен для перехода к следующей странице результатов вашего запроса.
Токен следующей страницы не возвращается, если больше нет результатов для отображения.
Чтобы получить следующую страницу результатов, выполните другой запрос GetAlarms и укажите токен следующей страницы с помощью параметра pageToken.
© Copyright 2025, Amazon Web Services. Created using Sphinx.