.. _PutMetricAlarm:

##############
PutMetricAlarm
##############

***********
Description
***********

Создаёт или обновляет аларм и связывает его с определённой метрикой.

******************
Request Parameters
******************

Необходимые параметры
=====================

- *AlarmName* — Имя аларма. Должно быть уникально для проекта пользователя.

  - Необходимо: Да
  - Тип: String
  - Ограничение длины: От 1 до 255 символов

- *ComparisonOperator* — Арифметическая операция, используемая для сравнения значений метрики с пороговым значением.

  - Необходимо: Да
  - Тип: String
  - Возможные значения: ``GreaterThanThreshold`` | ``GreaterThanOrEqualToThreshold`` | ``LessThanOrEqualToThreshold`` | ``LessThanThreshold``

- *Dimensions.member.N* — Измерения метрики (подробнее см. :ref:`документацию пользователя <Dimensions>`).

  - Необходимо: Да
  - Тип: Список объектов :ref:`Dimension`
  - Ограничение длины: От 0 до 10 элементов

- *EvaluationPeriods* — Количество периодов, сравниваемых с пороговым значением.

  - Необходимо: Да
  - Тип: Integer
  - Диапазон: Минимальное значение — ``1``
  - Ограничение: Период времени, указанный с помощью *EvaluationPeriods* и *Period*, должен быть не больше одних суток

- *MetricName* — Имя метрики, с которой ассоциирован аларм.

  - Необходимо: Да
  - Тип: String
  - Ограничение длины: От 1 до 255 символов

- *Namespace* — Пространство имён метрики, с которой ассоциирован аларм.

  - Необходимо: Да
  - Тип: String
  - Ограничение длины: От 1 до 255 символов

- *Period* — Период времени в секундах, к которому применяется выбранная статистика.

  - Необходимо: Да
  - Тип: Integer
  - Диапазон: Значение должно быть кратным 60, минимальное значение — ``60``
  - Ограничение: Период времени, указанный с помощью *EvaluationPeriods* и *Period*, должен быть не больше одних суток

- *Statistic* — Статистика, применяемая к метрике.

  - Необходимо: Да
  - Тип: String
  - Возможные значения: ``Average`` | ``Sum`` | ``SampleCount`` | ``Maximum`` | ``Minimum``

- *Threshold* — Пороговое значение, с которым производится сравнение выбранной статистики.

  - Необходимо: Да
  - Тип: Double

Опциональные параметры
======================

- *ActionsEnabled* — Показывает, будут ли действия выполнены при переходе аларма в соответствующее состояние.

  - Необходимо: Нет
  - Тип: Boolean

- *AlarmActions.member.N* — Действия, которые должны выполниться при переходе аларма в состояние ``alarm``.

  - Необходимо: Нет
  - Тип: Array of strings
  - Возможные значения: ``example@mail.com:EMAIL``
  - Ограничение длины (список): От 0 до 5 элементов
  - Ограничение длины (элемент): От 1 до 1024 символов

- *AlarmDescription* — Описание аларма.

  - Необходимо: Нет
  - Тип: String
  - Ограничение длины: От 1 до 255 символов

- *DatapointsToAlarm* — Параметр, определяющий количество точек, превышающих *Threshold*, для срабатывания аларма.

  - Необходимо: Нет
  - Тип: Integer
  - Диапазон: Минимальное значение — ``1``, максимальное значение — *EvaluationPeriods*
  - Значение по умолчанию: *EvaluationPeriods*

- *InsufficientDataActions.member.N* — Действия, которые должны выполниться при переходе аларма в состояние ``insufficient_data``.

  - Необходимо: Нет
  - Тип: Array of strings
  - Возможные значения: ``example@mail.com:EMAIL``
  - Ограничение длины (список): От 0 до 5 элементов
  - Ограничение длины (элемент): От 1 до 1024 символов

- *OKActions.member.N* — Действия, которые должны выполниться при переходе аларма в состояние ``ok``.

  - Необходимо: Нет
  - Тип: Array of strings
  - Возможные значения: ``example@mail.com:EMAIL``
  - Ограничение длины (список): От 0 до 5 элементов
  - Ограничение длины (элемент): От 1 до 1024 символов

- *TreatMissingData* — Параметр, определяющий, как будут интерпретироваться периоды без данных.
  Возможны четыре варианта: продолжить считать периодами без данных, игнорировать, считать превышающими порог, считать не превышающими порог.

  - Необходимо: Нет
  - Тип: String
  - Возможные значения: ``missing`` | ``ignore`` | ``breaching`` | ``non_breaching``
  - Значение по умолчанию: ``missing``

- *Unit* — Единица изменения метрики, ассоциированной с алармом.

  - Необходимо: Нет
  - Тип: String
  - Возможные значения: ``Percent`` | ``Bytes`` | ``Count``

********
Examples
********

.. code-block:: bash

   c2-cw PutMetricAlarm AlarmName <alarm_name> Period <period> MetricName <metric_name> \
                        Namespace <namespace> ComparisonOperator <comparison_operator> \
                        Threshold <threshold> EvaluationPeriods <evaluation_periods> \
                        Dimensions.member.1.Name "InstanceId" \
                        Dimensions.member.1.Value <instance_id> \
                        Statistic <statistic>

   c2-cw PutMetricAlarm AlarmName <alarm_name> Period <period> MetricName <metric_name> \
                        Namespace <namespace> ComparisonOperator <comparison_operator> \
                        Threshold <threshold> EvaluationPeriods <evaluation_periods> \
                        Dimensions.member.1.Name "InstanceId" \
                        Dimensions.member.1.Value <instance_id> \
                        Statistic <statistic> OKActions.member.1 <ok_action_1>