Spec-Zone.ru › AWS CLI v2

[ aws . cloudwatch ]

describe-alarms-for-metric

Описание

Получает оповещения для указанного метрического показателя. Для фильтрации результатов укажите статистику, период или единицу измерения.

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

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

Синтаксис

  describe-alarms-for-metric
--metric-name <value>
--namespace <value>
[--statistic <value>]
[--extended-statistic <value>]
[--dimensions <value>]
[--period <value>]
[--unit <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]

Параметры

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

Имя метрического показателя.

--namespace (строка)

Пространство имен метрического показателя.

--statistic (строка)

Статистика метрического показателя, кроме перцентилей. Для перцентильной статистики используйте ExtendedStatistics .

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

  • SampleCount
  • Average
  • Sum
  • Minimum
  • Maximum

--extended-statistic (строка)

Перцентильная статистика метрического показателя. Укажите значение от p0.0 до p100.

--dimensions (список)

Размеры, связанные с метрическим показателем. Если метрический показатель имеет какие-либо связанные размеры, вы должны указать их для успешного выполнения вызова.

(структура)

Размер — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, всякий раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера, а фактический идентификатор экземпляра — в качестве значения для этого размера.

Вы можете назначить до 30 размеров метрике.

Имя -> (строка)

Имя размера. Имена размеров должны содержать только символы ASCII, включать по крайней мере один не-пробельный символ и не начинаться с двоеточия (:). Символы управления ASCII не поддерживаются в именах размеров.

Значение -> (строка)

Значение размера. Значения размеров должны содержать только символы ASCII и включать по крайней мере один не-пробельный символ. Символы управления ASCII не поддерживаются в значениях размеров.

Сокращённый синтаксис:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--period (целое число)

Период в секундах, на протяжении которого применяется статистика.

--unit (строка)

Единица измерения метрического показателя.

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

  • Seconds
  • Microseconds
  • Milliseconds
  • Bytes
  • Kilobytes
  • Megabytes
  • Gigabytes
  • Terabytes
  • Bits
  • Kilobits
  • Megabits
  • Gigabits
  • Terabits
  • Percent
  • Count
  • Bytes/Second
  • Kilobytes/Second
  • Megabytes/Second
  • Gigabytes/Second
  • Terabytes/Second
  • Bits/Second
  • Kilobits/Second
  • Megabits/Second
  • Gigabits/Second
  • Terabits/Second
  • Count/Second
  • None

--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
  • текст
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для отображения информации об оповещениях, связанных с метрикой

В следующем примере используется команда describe-alarms-for-metric для отображения информации о любых оповещениях, связанных с метрикой использования ЦП Amazon EC2 и экземпляром с идентификатором i-0c986c72.:

aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72

Вывод:

{
    "MetricAlarms": [
        {
            "EvaluationPeriods": 10,
            "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2",
            "StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z",
            "AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z",
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "AlarmActions": [
                "arn:aws:sns:us-east-1:111122223333:NotifyMe"
            ],
            "Namespace": "AWS/EC2",
            "AlarmDescription": "CPU usage exceeds 70 percent",
            "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}",
            "Period": 300,
            "StateValue": "OK",
            "Threshold": 70.0,
            "AlarmName": "myHighCpuAlarm2",
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "i-0c986c72"
                }
            ],
            "Statistic": "Average",
            "StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].",
            "InsufficientDataActions": [],
            "OKActions": [],
            "ActionsEnabled": true,
            "MetricName": "CPUUtilization"
        },
        {
            "EvaluationPeriods": 2,
            "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm",
            "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
            "AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z",
            "ComparisonOperator": "GreaterThanThreshold",
            "AlarmActions": [
                "arn:aws:sns:us-east-1:111122223333:HighCPUAlarm"
            ],
            "Namespace": "AWS/EC2",
            "AlarmDescription": "CPU usage exceeds 70 percent",
            "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}",
            "Period": 300,
            "StateValue": "OK",
            "Threshold": 70.0,
            "AlarmName": "myHighCpuAlarm",
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "i-0c986c72"
                }
            ],
            "Statistic": "Average",
            "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
            "InsufficientDataActions": [],
            "OKActions": [],
            "ActionsEnabled": false,
            "MetricName": "CPUUtilization"
        }
    ]
}

Вывод

MetricAlarms -> (список)

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

(структура)

Подробности о срабатывании сигнализации по метрике.

AlarmName -> (строка)

Имя сигнализации.

AlarmArn -> (строка)

Amazon Resource Name (ARN) сигнализации.

AlarmDescription -> (строка)

Описание сигнализации.

AlarmConfigurationUpdatedTimestamp -> (отметка времени)

Отметка времени последнего обновления конфигурации сигнализации.

ActionsEnabled -> (булево)

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

OKActions -> (список)

Действия, которые выполняются, когда сигнализация переходит в состояние OK из любого другого состояния. Каждое действие указано как Amazon Resource Name (ARN).

(строка)

AlarmActions -> (список)

Действия, которые выполняются, когда сигнализация переходит в состояние ALARM из любого другого состояния. Каждое действие указано как Amazon Resource Name (ARN).

(строка)

InsufficientDataActions -> (список)

Действия, которые выполняются, когда сигнализация переходит в состояние INSUFFICIENT_DATA из любого другого состояния. Каждое действие указано как Amazon Resource Name (ARN).

(строка)

StateValue -> (строка)

Значение состояния сигнализации.

StateReason -> (строка)

Объяснение состояния сигнализации в текстовом формате.

StateReasonData -> (строка)

Объяснение состояния сигнализации в формате JSON.

StateUpdatedTimestamp -> (отметка времени)

Отметка времени последнего обновления значения параметров StateValue или EvaluationState.

MetricName -> (строка)

Имя метрики, связанной с сигнализацией, если это сигнализация, основанная на одной метрике.

Namespace -> (строка)

Пространство имен метрики, связанной с сигнализацией.

Statistic -> (строка)

Статистика метрики, связанной с сигнализацией, отличная от процентиля. Для процентильных статистик используйте ExtendedStatistic.

ExtendedStatistic -> (строка)

Процентильная статистика метрики, связанной с сигнализацией. Укажите значение от p0.0 до p100.

Dimensions -> (список)

Размеры метрики, связанной с сигнализацией.

(структура)

Размер — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из ваших метрик, вы создаёте новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера и фактический идентификатор экземпляра в качестве значения этого размера.

Вы можете назначить до 30 размеров метрике.

Name -> (строка)

Имя размера. Имена размеров должны содержать только символы ASCII, содержать по крайней мере один символ, отличный от пробела, и не начинаться с двоеточия (:). ASCII управляющие символы не поддерживаются в качестве части имен размеров.

Value -> (строка)

Значение размера. Значения размеров должны содержать только символы ASCII и содержать по крайней мере один символ, отличный от пробела. ASCII управляющие символы не поддерживаются в качестве части значений размеров.

Period -> (целое число)

Период в секундах, в течение которого применяется статистика.

Unit -> (строка)

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

EvaluationPeriods -> (целое число)

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

DatapointsToAlarm -> (целое число)

Количество точек данных, которые должны быть нарушены для срабатывания сигнализации.

Threshold -> (двойное)

Значение для сравнения со заданной статистикой.

ComparisonOperator -> (строка)

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

TreatMissingData -> (строка)

Определяет, как эта сигнализация обрабатывает пропущенные точки данных. Допустимые значения — breaching , notBreaching , ignore и missing. Дополнительную информацию см. в разделе Настройка обработки пропущенных данных сигнализацией CloudWatch.

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

EvaluateLowSampleCountPercentile -> (строка)

Используется только для сигнализаций, основанных на процентилях. Если ignore, состояние сигнализации не изменяется в периоды с слишком малым количеством точек данных для статистически значимого результата. Если evaluate или этот параметр не используется, сигнализация всегда оценивается и, возможно, изменяет состояние независимо от доступного количества точек данных.

Metrics -> (список)

Массив структур MetricDataQuery, используемых в тревоге, основанной на математическом выражении метрики. Каждая структура либо извлекает метрику, либо выполняет математическое выражение. Один элемент в массиве Metrics является математическим выражением, за которым следит тревога. Это выражение обозначается установкой ReturnData в значение true.

(структура)

Эта структура используется как в GetMetricData, так и в PutMetricAlarm. Поддерживаемое использование этой структуры отличается для этих двух операций.

При использовании в GetMetricData она указывает метрические данные для возврата и то, является ли этот вызов просто извлечением набора данных для одной метрики, или выполнением запроса Metrics Insights или математического выражения. Один вызов GetMetricData может включать до 500 структур MetricDataQuery.

При использовании в PutMetricAlarm она позволяет создать тревогу, основанную на математическом выражении метрики. Каждая структура MetricDataQuery в массиве определяет либо метрику для извлечения, либо математическое выражение, которое нужно выполнить над извлечёнными метриками. Один вызов PutMetricAlarm может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression одна должна иметь значение true для параметра ReturnData. Результатом этого выражения является значение, за которым следит тревога.

Любое выражение, используемое в операции PutMetricAlarm, должно возвращать единственный временной ряд. Для получения дополнительной информации см. Синтаксис и функции математических выражений для метрик в Руководстве пользователя Amazon CloudWatch.

Некоторые параметры этой структуры также имеют различное использование в зависимости от того, используете ли вы эту структуру в операции GetMetricData или в операции PutMetricAlarm. Эти различия объяснены в следующем списке параметров.

Id -> (строка)

Короткое имя, используемое для связи этого объекта с результатами в ответе. Это имя должно быть уникальным в пределах одного вызова GetMetricData. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

Метрика, подлежащая возврату, вместе со статистикой, периодом и единицами измерения. Используйте этот параметр только в том случае, если этот объект извлекает метрику, а не выполняет математическое выражение над возвращёнными данными.

В рамках одного объекта MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Возвращаемая метрика, включая имя метрики, пространство имён и размерности.

Namespace -> (строка)

Пространство имён метрики.

MetricName -> (строка)

Имя метрики. Это обязательное поле.

Dimensions -> (список)

Размерности для метрики.

(структура)

Размерность — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку размерности являются частью уникального идентификатора метрики, всякий раз, когда вы добавляете уникальную пару «имя/значение» к одной из своих метрик, вы создаёте новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размерности, а фактический идентификатор экземпляра — в качестве значения этой размерности.

Вы можете назначить до 30 размерностей метрике.

Name -> (строка)

Имя размерности. Имена размерностей должны содержать только символы ASCII, включать по крайней мере один символ, отличный от пробела, и не начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в качестве части имён размерностей.

Value -> (строка)

Значение размерности. Значения размерностей должны содержать только символы ASCII и включать по крайней мере один символ, отличный от пробела. ASCII-управляющие символы не поддерживаются в качестве части значений размерностей.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 20, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает StorageResolution в 1 секунду.

Если параметр StartTime указывает отметку времени, которая старше 3 часов, вы должны указать период следующим образом, иначе не будут возвращены точки данных в этом диапазоне времени:

  • Начало времени между 3 часами и 15 днями назад — использовать кратное 60 секундам (1 минута).
  • Начало времени между 15 и 63 днями назад — использовать кратное 300 секундам (5 минут).
  • Начало времени более 63 дней назад — использовать кратное 3600 секундам (1 час).

Stat -> (строка)

Статистика для возврата. Она может включать любую статистику CloudWatch или расширенную статистику.

Unit -> (строка)

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

В операции Get, если вы опустите Unit, то будут возвращены все данные, собранные с любыми единицами измерения, а также соответствующие единицы измерения, которые были указаны при отчётности данных в CloudWatch. Если вы укажете единицу измерения, операция вернёт только данные, собранные с указанной единицей измерения. Если вы укажете единицу измерения, которая не соответствует собранным данным, результаты операции будут null. CloudWatch не выполняет преобразования единиц измерения.

Expression -> (строка)

Это поле может содержать либо запрос Metrics Insights, либо математическое выражение метрики, которое нужно выполнить над возвращенными данными. Более подробную информацию о запросах Metrics Insights см. в разделе Компоненты и синтаксис запросов Metrics Insights в Руководстве пользователя Amazon CloudWatch.

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики и может также использовать Id других выражений для использования результата этих выражений. Более подробную информацию о математических выражениях метрик см. в разделе Синтаксис и функции математических выражений для метрик в Руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекопонятное имя метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что оно представляет собой. Если метрика или выражение отображаются в виджете панели мониторинга CloudWatch, имя отображается. Если Label опущен, CloudWatch генерирует значение по умолчанию.

Вы можете поместить динамические выражения в имя, чтобы сделать его более описательным. Более подробную информацию см. в разделе Использование динамических имён.

ReturnData -> (логическое значение)

При использовании в GetMetricData этот параметр указывает, следует ли возвращать метки времени и исходные значения данных этой метрики. Если вы выполняете этот вызов только для выполнения математических выражений и не нуждаетесь в возврате исходных данных, вы можете указать false. Если вы это пропустите, будет использоваться значение по умолчанию true.

При использовании в PutMetricAlarm укажите true для использования результата одного выражения в качестве тревоги. Для всех других метрик и выражений в той же операции PutMetricAlarm укажите ReturnData как False.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 20, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся в результате операции PutMetricData, включающей StorageResolution of 1 second.

AccountId -> (строка)

Идентификатор учётной записи, где находятся метрики.

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

Если вы выполняете операцию PutMetricAlarm, используйте этот параметр для указания учётной записи, содержащей метрику, за которой следит тревога.

ThresholdMetricId -> (строка)

В тревоге, основанной на модели обнаружения аномалий, это идентификатор функции ANOMALY_DETECTION_BAND, используемой в качестве порога для тревоги.

EvaluationState -> (строка)

Если значение этого поля равно PARTIAL_DATA, тревога оценивается на основе частичных данных. Это происходит, если запрос, используемый для тревоги, возвращает более 10 000 метрик. Более подробную информацию см. в разделе Создание тревог на основе запросов Metrics Insights.

StateTransitionedTimestamp -> (отметка времени)

Дата и время, когда состояние тревоги StateValue изменилось в последний раз.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API