put-alarm

Описание

Создаёт или обновляет тревогу и ассоциирует её со значением указанного метрики.

Тревога используется для мониторинга одной метрики одного из ваших ресурсов. Когда выполняется условие метрики, тревога может уведомить вас по электронной почте, SMS-сообщению и баннером, отображаемым в консоли Amazon Lightsail. Дополнительную информацию см. в разделе Тревоги в Amazon Lightsail .

Когда это действие создаёт тревогу, состояние тревоги сразу устанавливается в INSUFFICIENT_DATA. Затем тревога оценивается, и её состояние устанавливается соответствующим образом. После этого выполняются все действия, связанные с новым состоянием.

При обновлении существующей тревоги её состояние остаётся неизменным, но обновление полностью перезаписывает предыдущую конфигурацию тревоги. Затем тревога оценивается с обновлённой конфигурацией.

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

Синтаксис

  put-alarm
--alarm-name <value>
--metric-name <value>
--monitored-resource-name <value>
--comparison-operator <value>
--threshold <value>
--evaluation-periods <value>
[--datapoints-to-alarm <value>]
[--treat-missing-data <value>]
[--contact-protocols <value>]
[--notification-triggers <value>]
[--notification-enabled | --no-notification-enabled]
[--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 (строка)

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

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

Имя метрики, которую нужно ассоциировать с тревогой.

Вы можете настроить до двух тревог на одну метрику.

Для каждого типа ресурсов доступны следующие метрики:

Instances : BurstCapacityPercentage , BurstCapacityTime , CPUUtilization , NetworkIn , NetworkOut , StatusCheckFailed , StatusCheckFailed_Instance , и StatusCheckFailed_System .
Load balancers : ClientTLSNegotiationErrorCount , HealthyHostCount , UnhealthyHostCount , HTTPCode_LB_4XX_Count , HTTPCode_LB_5XX_Count , HTTPCode_Instance_2XX_Count , HTTPCode_Instance_3XX_Count , HTTPCode_Instance_4XX_Count , HTTPCode_Instance_5XX_Count , InstanceResponseTime , RejectedConnectionCount , и RequestCount .
Relational databases : CPUUtilization , DatabaseConnections , DiskQueueDepth , FreeStorageSpace , NetworkReceiveThroughput , и NetworkTransmitThroughput .

Дополнительную информацию об этих метриках см. в разделе Доступные метрики в Lightsail .

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

CPUUtilization
NetworkIn
NetworkOut
StatusCheckFailed
StatusCheckFailed_Instance
StatusCheckFailed_System
ClientTLSNegotiationErrorCount
HealthyHostCount
UnhealthyHostCount
HTTPCode_LB_4XX_Count
HTTPCode_LB_5XX_Count
HTTPCode_Instance_2XX_Count
HTTPCode_Instance_3XX_Count
HTTPCode_Instance_4XX_Count
HTTPCode_Instance_5XX_Count
InstanceResponseTime
RejectedConnectionCount
RequestCount
DatabaseConnections
DiskQueueDepth
FreeStorageSpace
NetworkReceiveThroughput
NetworkTransmitThroughput
BurstCapacityTime
BurstCapacityPercentage

--monitored-resource-name (строка)

Имя ресурса Lightsail, который будет отслеживаться.

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

--comparison-operator (строка)

Арифметическое действие, которое нужно использовать при сравнении заданной статистики с порогом. Заданное значение статистики используется в качестве первого операнда.

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

GreaterThanOrEqualToThreshold
GreaterThanThreshold
LessThanThreshold
LessThanOrEqualToThreshold

--threshold (двойное значение)

Значение, с которым сравнивается заданная статистика.

--evaluation-periods (целое число)

Количество последних периодов, в течение которых данные сравниваются с заданным порогом. Если вы устанавливаете тревогу «M из N», это значение (evaluationPeriods) — это N.

Если вы настраиваете тревогу, которая требует, чтобы несколько последовательных точек данных выходили за пределы, для срабатывания тревоги, это значение определяет период времени, в течение которого оцениваются точки данных.

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

Вы можете указать минимальный период оценки 1 (5 минут) и максимальный период оценки 288 (24 часа).

--datapoints-to-alarm (целое число)

Количество точек данных, которые не должны быть в пределах заданного порога, чтобы сработать тревога. Если вы устанавливаете тревогу «M из N», это значение (datapointsToAlarm) — это M.

--treat-missing-data (строка)

Устанавливает, как эта тревога будет обрабатывать пропущенные точки данных.

Тревога может обрабатывать пропущенные данные следующими способами:

breaching — Предполагается, что пропущенные данные находятся вне порога. Пропущенные данные учитываются в количестве случаев, когда метрика не находится в пределах порога.
notBreaching — Предполагается, что пропущенные данные находятся в пределах порога. Пропущенные данные не учитываются в количестве случаев, когда метрика не находится в пределах порога.
ignore — Пропущенные данные игнорируются. Сохраняется текущее состояние тревоги.
missing — Пропущенные данные обрабатываются как пропущенные.

Если treatMissingData не указан, используется поведение по умолчанию missing.

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

breaching
notBreaching
ignore
missing

--contact-protocols (список)

Протоколы связи для тревоги, такие как Email , SMS (сообщения по SMS), или оба.

Уведомление отправляется по указанному протоколу связи, если уведомления включены для тревоги и когда тревога срабатывает.

Уведомление не отправляется, если протокол связи не указан, если указанный протокол связи не настроен в регионе Amazon Web Services или если уведомления не включены для тревоги с помощью параметра notificationEnabled.

Используйте действие CreateContactMethod для настройки протокола связи в регионе Amazon Web Services.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Email
  SMS

--notification-triggers (список)

Состояния тревоги, которые вызывают уведомление.

Тревога имеет следующие возможные состояния:

ALARM — Метрика находится вне заданного порога.
INSUFFICIENT_DATA — Тревога только что началась, метрика недоступна или недостаточно данных для определения состояния тревоги.
OK — Метрика находится в пределах заданного порога.

При указании триггера уведомления состояние ALARM должно быть указано. Состояния INSUFFICIENT_DATA и OK могут быть указаны в дополнение к состоянию ALARM.

Если вы укажете OK в качестве триггера тревоги, уведомление отправляется, когда тревога переключается из состояния тревоги ALARM или INSUFFICIENT_DATA в состояние OK. Это можно рассматривать как уведомление тревоги «все в порядке».
Если вы укажете INSUFFICIENT_DATA в качестве триггера тревоги, уведомление отправляется, когда тревога переключается из состояния тревоги OK или ALARM в состояние INSUFFICIENT_DATA.

Триггер уведомления по умолчанию устанавливается в ALARM, если этот параметр не указан.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  OK
  ALARM
  INSUFFICIENT_DATA

--notification-enabled | --no-notification-enabled (логическое значение)

Указывает, включена ли тревога.

Уведомления включены по умолчанию, если вы не указали этот параметр.

--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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Заменить стандартный URL команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

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

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить кли-страничник для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы входных параметров CLI.

Вывод

operations -> (list)

Массив объектов, описывающих результат действия, например, статус запроса, отметку времени запроса и ресурсы, затронутые запросом.

(structure)

Описание операции API.

id -> (string)

Идентификатор операции.

resourceName -> (string)

Имя ресурса.

resourceType -> (string)

Тип ресурса.

createdAt -> (timestamp)

Отметка времени инициализации операции (1479816991.349).

location -> (structure)

Регион и зона доступности Amazon Web Services.

availabilityZone -> (string)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (string)

Имя региона Amazon Web Services.

isTerminal -> (boolean)

Булево значение, указывающее, является ли операция терминальной.

operationDetails -> (string)

Подробности об операции (Debian-1GB-Ohio-1).

operationType -> (string)

Тип операции.

status -> (string)

Статус операции.

statusChangedAt -> (timestamp)

Отметка времени изменения статуса (1479816991.349).

errorCode -> (string)

Код ошибки.

errorDetails -> (string)

Подробности об ошибке.