Spec-Zone.ru › AWS CLI v2

[ aws . cloudwatch ]

put-metric-alarm

Описание

Создает или обновляет тревогу и связывает ее с указанным метрикой, математическим выражением метрик, моделью обнаружения аномалий или запросом Metrics Insights. Дополнительную информацию об использовании запроса Metrics Insights для тревоги см. в разделе Создание тревог на основе запросов Metrics Insights.

Тревоги, основанные на моделях обнаружения аномалий, не могут иметь действий Auto Scaling.

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

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

Если вы являетесь пользователем IAM, вам необходимо иметь права Amazon EC2 для некоторых операций с тревогами:

  • Право iam:CreateServiceLinkedRole для всех тревог с действиями EC2
  • Права iam:CreateServiceLinkedRole для создания тревоги с действиями Systems Manager OpsItem или планами реагирования.

В первый раз при создании тревоги в Amazon Web Services Management Console, командной строке или с помощью API PutMetricAlarm CloudWatch создает для вас необходимые роли служб. Эти роли служб называются AWSServiceRoleForCloudWatchEvents и AWSServiceRoleForCloudWatchAlarms_ActionSSM . Дополнительную информацию см. в разделе Роли служб Amazon Web Services.

У каждого действия PutMetricAlarm есть максимальный объем данных без сжатия 120 КБ.

Тревоги между учетными записями

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

  • Учетная запись, где находятся метрики (учетная запись, предоставляющая доступ), должна уже иметь роль с именем CloudWatch-CrossAccountSharingRole. Если этой роли нет, вы должны создать ее, используя инструкции в разделе Настройка учетной записи, предоставляющей доступ в разделе Междуучетная тревога CloudWatch между регионами. Политика этой роли должна предоставлять доступ к идентификатору учетной записи, в которой вы создаете тревогу.
  • Учетная запись, в которой вы создаете тревогу (учетная запись, отслеживающая), должна иметь роль служб с именем AWSServiceRoleForCloudWatchCrossAccount, чтобы CloudWatch могла принять роль доступа в учетной записи, предоставляющей доступ. Если ее нет, вы должны создать ее, следуя инструкциям в разделе Настройка учетной записи, отслеживающей в разделе Междуучетная тревога CloudWatch между регионами.

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

Синтаксис

  put-metric-alarm
--alarm-name <value>
[--alarm-description <value>]
[--actions-enabled | --no-actions-enabled]
[--ok-actions <value>]
[--alarm-actions <value>]
[--insufficient-data-actions <value>]
[--metric-name <value>]
[--namespace <value>]
[--statistic <value>]
[--extended-statistic <value>]
[--dimensions <value>]
[--period <value>]
[--unit <value>]
--evaluation-periods <value>
[--datapoints-to-alarm <value>]
[--threshold <value>]
--comparison-operator <value>
[--treat-missing-data <value>]
[--evaluate-low-sample-count-percentile <value>]
[--metrics <value>]
[--tags <value>]
[--threshold-metric-id <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 (строка)

Имя тревоги. Это имя должно быть уникальным в Регионе.

Имя должно содержать только символы UTF-8 и не может содержать управляющие символы ASCII.

--alarm-description (строка)

Описание тревоги.

--actions-enabled | --no-actions-enabled (булево)

Указывает, должны ли выполняться действия при изменении состояния тревоги. По умолчанию - TRUE .

--ok-actions (список)

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

Действия EC2:
  • arn:aws:automate:*region* :ec2:stop
  • arn:aws:automate:*region* :ec2:terminate
  • arn:aws:automate:*region* :ec2:reboot
  • arn:aws:automate:*region* :ec2:recover
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
Действие автомасштабирования:
  • ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Действия Lambda:
  • Вызвать последнюю версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызвать определенную версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызвать функцию с помощью алиаса функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``
Действие уведомления SNS:
  • ``arn:aws:sns:region :account-id :sns-topic-name ``
Действия интеграции SSM:
  • ``arn:aws:ssm:region :account-id :opsitem:severity #CATEGORY=*category-name* ``
  • ``arn:aws:ssm-incidents::account-id :responseplan/response-plan-name ``

(строка)

Синтаксис:

"string" "string" ...

--alarm-actions (список)

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

Действия EC2:
  • arn:aws:automate:*region* :ec2:stop
  • arn:aws:automate:*region* :ec2:terminate
  • arn:aws:automate:*region* :ec2:reboot
  • arn:aws:automate:*region* :ec2:recover
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
Действие автомасштабирования:
  • ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Действия Lambda:
  • Вызвать последнюю версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызвать определенную версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызвать функцию с помощью алиаса функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``
Действие уведомления SNS:
  • ``arn:aws:sns:region :account-id :sns-topic-name ``
Действия интеграции SSM:
  • ``arn:aws:ssm:region :account-id :opsitem:severity #CATEGORY=*category-name* ``
  • ``arn:aws:ssm-incidents::account-id :responseplan/response-plan-name ``

Запустить оперативное расследование Amazon Q Developer

``arn:aws:aiops:region :account-id :investigation-group:investigation-group-id ``

(строка)

Синтаксис:

"string" "string" ...

--insufficient-data-actions (список)

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

Действия EC2:
  • arn:aws:automate:*region* :ec2:stop
  • arn:aws:automate:*region* :ec2:terminate
  • arn:aws:automate:*region* :ec2:reboot
  • arn:aws:automate:*region* :ec2:recover
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
  • arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
Действие автомасштабирования:
  • ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Действия Lambda:
  • Вызвать последнюю версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name ``
  • Вызвать определенную версию функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :version-number ``
  • Вызвать функцию с помощью алиаса функции Lambda: ``arn:aws:lambda:region :account-id :function:function-name :alias-name ``
Действие уведомления SNS:
  • ``arn:aws:sns:region :account-id :sns-topic-name ``
Действия интеграции SSM:
  • ``arn:aws:ssm:region :account-id :opsitem:severity #CATEGORY=*category-name* ``
  • ``arn:aws:ssm-incidents::account-id :responseplan/response-plan-name ``

(строка)

Синтаксис:

"string" "string" ...

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

Имя метрики, связанной с тревогой. Для каждой операции PutMetricAlarm вы должны указать либо MetricName, либо массив Metrics.

Если вы создаете тревогу на основе математического выражения, вы не можете указать этот параметр или любой из параметров Namespace, Dimensions, Period, Unit, Statistic или ExtendedStatistic. Вместо этого вы указываете всю эту информацию в массиве Metrics.

--namespace (строка)

Пространство имен метрики, указанное в MetricName.

--statistic (строка)

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

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

  • SampleCount
  • Average
  • Sum
  • Minimum
  • Maximum

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

Расширенная статистика для метрики, указанной в MetricName. Когда вы вызываете PutMetricAlarm и указываете MetricName, вы должны указать либо Statistic, либо ExtendedStatistic, но не оба.

Если вы указываете ExtendedStatistic, допустимыми значениями являются:

  • p90
  • tm90
  • tc90
  • ts90
  • wm90
  • IQM
  • PR(*n* :*m* ) где n и m — значения метрики
  • TC(*X* %:*X* %) где X находится в диапазоне от 10 до 90 включительно.
  • TM(*X* %:*X* %) где X находится в диапазоне от 10 до 90 включительно.
  • TS(*X* %:*X* %) где X находится в диапазоне от 10 до 90 включительно.
  • WM(*X* %:*X* %) где X находится в диапазоне от 10 до 90 включительно.

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

--dimensions (список)

Размеры метрики, указанной в MetricName.

(структура)

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

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

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

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

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

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

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

Name=string,Value=string ...

Синтаксис JSON:

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

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

Длина, в секундах, используемая каждый раз при оценке метрики, указанной в MetricName. Допустимые значения: 10, 20, 30 и любые кратные 60.

Period требуется для тревог, основанных на статических порогах. Если вы создаете тревогу, основанную на математическом выражении метрики, период для каждой метрики указывается в объектах в массиве Metrics.

Убедитесь, что вы указываете 10, 20 или 30 только для метрик, которые хранятся с помощью вызова PutMetricData с StorageResolution значением 1. Если вы указываете период 10, 20 или 30 для метрики, которая не имеет разрешения под минуту, тревога по-прежнему пытается собирать данные с указанной скоростью. В этом случае она не получает данные для попыток, которые не соответствуют разрешению данных в одну минуту, и тревога может часто переходить в состояние INSUFFICENT_DATA. Указание 10, 20 или 30 также устанавливает эту тревогу как тревогу с высоким разрешением, которая имеет более высокую плату, чем другие тревоги. Дополнительную информацию о ценообразовании см. на странице Amazon CloudWatch Pricing.

Общий текущий период оценки тревоги не может превышать семь дней, поэтому Period, умноженное на EvaluationPeriods, не может быть больше 604 800 секунд. Для тревог с периодом менее одного часа (3600 секунд) общий период оценки не может быть больше одного дня (86 400 секунд).

--unit (строка)

Единица измерения статистики. Например, единицами измерения метрики Amazon EC2 NetworkIn являются байты, так как NetworkIn отслеживает количество байтов, которые получает экземпляр на всех сетевых интерфейсах. Вы также можете указать единицу измерения при создании пользовательской метрики. Единицы измерения помогают придать концептуальное значение вашим данным. Точки данных метрики, которые указывают единицу измерения, такую как Процент, агрегируются отдельно. Если вы создаете тревогу, основанную на математическом выражении метрики, вы можете указать единицу измерения для каждой метрики (при необходимости) внутри объектов в массиве Metrics.

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

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

Рекомендуется опустить Unit, чтобы случайно не указать неправильную единицу измерения, которая не опубликована для этой метрики. В этом случае тревога застревает в состоянии INSUFFICIENT DATA.

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

  • 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

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

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

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

Количество точек данных, которые должны нарушить порог для срабатывания тревоги. Это используется только при настройке тревоги "M из N". В этом случае это значение равно M. Дополнительную информацию см. в разделе Оценка тревоги в руководстве пользователя Amazon CloudWatch.

--threshold (двойное число)

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

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

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

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

Значения LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold и GreaterThanUpperThreshold используются только для тревог, основанных на моделях выявления аномалий.

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

  • GreaterThanOrEqualToThreshold
  • GreaterThanThreshold
  • LessThanThreshold
  • LessThanOrEqualToThreshold
  • LessThanLowerOrGreaterThanUpperThreshold
  • LessThanLowerThreshold
  • GreaterThanUpperThreshold

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

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

Допустимые значения: breaching | notBreaching | ignore | missing

Примечание

Тревоги, которые оценивают метрики в пространстве имен AWS/DynamoDB, всегда ignore пропущенные данные, даже если вы выберите другой вариант для TreatMissingData. Когда у метрики AWS/DynamoDB есть пропущенные данные, тревоги, которые оценивают эту метрику, остаются в своем текущем состоянии.

--evaluate-low-sample-count-percentile (строка)

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

Допустимые значения: evaluate | ignore

--metrics (список)

Массив структур MetricDataQuery, позволяющий создавать тревогу на основе математического выражения метрики. Для каждой операции PutMetricAlarm необходимо указать либо MetricName, либо массив Metrics.

Каждый элемент в массиве Metrics либо извлекает метрику, либо выполняет математическое выражение.

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

Если используется параметр Metrics, нельзя включать параметры Namespace, MetricName, Dimensions, Period, Unit, Statistic или ExtendedStatistic операции PutMetricAlarm. Вместо этого метрики, используемые в математическом выражении, извлекаются в массиве Metrics.

(структура)

Эта структура используется как в операции 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, используйте этот параметр для указания учётной записи, содержащей метрику, за которой следит тревога.

Синтаксис JSON:

[
  {
    "Id": "string",
    "MetricStat": {
      "Metric": {
        "Namespace": "string",
        "MetricName": "string",
        "Dimensions": [
          {
            "Name": "string",
            "Value": "string"
          }
          ...
        ]
      },
      "Period": integer,
      "Stat": "string",
      "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"
    },
    "Expression": "string",
    "Label": "string",
    "ReturnData": true|false,
    "Period": integer,
    "AccountId": "string"
  }
  ...
]

--tags (список)

Список пар «ключ-значение» для связывания с тревогой. Вы можете связать до 50 тегов с тревогой. Для возможности связывания тегов с тревогой при создании тревоги требуется разрешение cloudwatch:TagResource.

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

Если вы используете эту операцию для обновления существующей тревоги, все указанные в этом параметре теги игнорируются. Для изменения тегов существующей тревоги используйте TagResource или UntagResource.

Чтобы использовать это поле для установки тегов тревоги при её создании, необходимо иметь как разрешение cloudwatch:PutMetricAlarm, так и разрешение cloudwatch:TagResource.

(структура)

Пара «ключ-значение», связанная с ресурсом CloudWatch.

Key -> (строка)

Строка, которую можно использовать для назначения значения. Сочетание ключей и значений тегов помогает организовать и категоризировать ваши ресурсы.

Value -> (строка)

Значение для указанного ключа тега.

Краткая запись синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

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

--threshold-metric-id (строка)

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

Пример использования этого параметра см. в примере Тревоги модели обнаружения аномалий на этой странице.

Если ваша тревога использует этот параметр, она не может иметь действия Auto Scaling.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Отправка электронного сообщения Amazon Simple Notification Service при превышении уровня использования ЦП на 70 процентов

В следующем примере используется команда put-metric-alarm для отправки электронного сообщения Amazon Simple Notification Service при превышении уровня использования ЦП на 70 процентов:

aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold  --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent

Если команда выполнена успешно, она вернётся в командную строку. Если тревога с тем же именем уже существует, она будет перезаписана новой тревогой.

Указание нескольких измерений

Следующий пример демонстрирует, как указать несколько измерений. Каждое измерение задаётся в виде пары "Имя/Значение", с запятой между именем и значением. Несколько измерений разделяются пробелами:

aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2

Вывод

Отсутствует

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

Spec-Zone.ru

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