DescribeAlarms#

Description#

Возвращает алармы по списку имен.

Также можно выставлять фильтры на префикс имени, состояние аларма, префикс любого действия аларма.

Request Parameters#

  • ActionPrefix — Префикс действия аларма.

    • Необходимо: Нет

    • Тип: String

    • Ограничение длины: От 1 до 1024 символов

    • Ограничение: Не может быть определён одновременно с AlarmNamePrefix

  • AlarmNamePrefix — Префикс имени аларма.

    • Необходимо: Нет

    • Тип: String

    • Ограничение длины: От 1 до 255 символов

    • Ограничение: Не может быть определён одновременно с AlarmNames

  • AlarmNames.member.N — Имена алармов.

    • Необходимо: Нет

    • Тип: Array of strings

    • Ограничение длины (список): От 0 до 100 элементов

    • Ограничение длины (строка): От 1 до 255 символов

    • Ограничение: Не может быть определено одновременно с AlarmNamePrefix

  • Dimensions.member.N — Измерения метрики (подробнее см. документацию пользователя). Атрибуты Name переданных объектов Dimension не должны отличаться.

    • Необходимо: Нет

    • Тип: Список объектов Dimension

    • Ограничение длины: От 0 до 10 элементов

  • MaxRecords — Ограничение на количество возвращаемых алармов.

    • Необходимо: Нет

    • Тип: Integer

    • Диапазон: От 1 до 100

    • Значение по умолчанию: 20

  • MetricName — Имя метрики.

    • Необходимо: Нет

    • Тип: String

  • NextTokenNextToken из предыдущего вызова (см. Response Elements).

    • Необходимо: Нет

    • Тип: String

  • StateValue — Состояние аларма.

    • Необходимо: Нет

    • Тип: String

    • Возможные значения: ok | alarm | insufficient_data

Response Elements#

  • MetricAlarms — Список алармов.

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

    • Тип: String

Examples#

c2-cw DescribeAlarms

c2-cw DescribeAlarms AlarmNames.member.1 <alarm_name_1> AlarmNames.member.2 <alarm_name_2>

c2-cw DescribeAlarms AlarmNamePrefix <alarm_name_prefix> NextToken <next_token>