mon-put-metric-alarm - Amazon CloudWatch
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

mon-put-metric-alarm

Description

创建或更新警报并将它与指定的 CloudWatch 指标关联。您还可以使用此命令将一个或多个 Amazon Simple Notification Service (Amazon SNS) 资源与警报关联。

此操作创建警报时,警报状态立即设置为 INSUFFICIENT_DATA。将评估警报,并适当设置其 StateValue。然后执行与 StateValue 关联的所有操作。

注意

更新现有警报时,StateValue 将保持不变。

Syntax

mon-put-metric-alarm AlarmName --comparison-operator value --evaluation-periods value --metric-name value --namespace value --period value [--statistic value] [--extendedstatistic value] --threshold value [--actions-enabled value] [--alarm-actions value[,value...] ] [--alarm-description value] [--dimensions "key1=value1,key2=value2..."] [--ok-actions value[,value...] ] [--unit value] [--insufficient-data-actions value[,value...]] [Common Options]

Options

名称 描述

AlarmName

要更新或创建的警报的名称。该名称在Amazonaccount. 还可以使用 --alarm-name 设置此值。

类型: 参数

有效值:UTF-8 字符串。

默认值:不适用

:必需 是

--actions-enabled VALUE

指示在警报状态更改时是否应执行操作。

类型: Boolean

有效值:True 或 false

默认值:True

:必需 否

--alarm-actions VALUE1,VALUE2,VALUE3...

当此警报从任何其他状态转换为 ALARM 状态时,要执行的操作(最多五个)。每个操作都被指定为一个Amazon 资源名称 (ARN)。使用警报操作,您可发布到 Amazon SNS 主题,激活 Amazon EC2 Auto Scaling 策略,或停止、终止或恢复 Amazon EC2 实例。

注意

如果您要使用 AWS Identity and Access Management (IAM) 账户创建或修改警报,则必须拥有以下 Amazon EC2 权限:

  • ec2:DescribeInstanceStatusec2:DescribeInstances,了解有关 Amazon EC2 实例状态指标的所有警报。

  • ec2:StopInstances,针对包含停止操作的警报。

  • ec2:TerminateInstances,针对包含终止操作的警报。

  • ec2:DescribeInstanceRecoveryAttributeec2:RecoverInstances,针对包含恢复操作的警报。

如果您拥有对 Amazon CloudWatch 而不是 Amazon EC2 的读/写权限,则仍然可以创建警报,但无法对 Amazon EC2 实例执行停止或终止操作。但是,如果您稍后获得了使用关联 Amazon EC2 API 的权限,将执行您以前创建的警报操作。有关 IAM 权限的更多信息,请参阅权限与策略IAM 用户指南

如果您使用的是 IAM 角色(例如,Amazon EC2 实例配置文件),则无法使用警报操作来停止或终止实例。但是,您仍然可以查看警报状态和执行任何其他操作,如 Amazon SNS 通知或 Amazon EC2 Auto Scaling 策略。

如果您使用的是用Amazon Security Token Service(Amazon STS),则无法使用警报操作来停止或终止 Amazon EC2 实例。

类型: 字符串

有效值:Amazon SNS 主题的 ARN、自动扩展策略或停止、终止或恢复 Amazon EC2 实例的 ARN。

默认值:不适用

:必需 否

--alarm-description VALUE

警报的描述。

类型: 字符串

有效值:长度介于 1 到 255 个字符之间的任何 Unicode 字符串。

默认值:不适用

:必需 否

--comparison-operator VALUE

用于比较数据点与阈值的比较运算符。

类型: 枚举

有效值:GreaterThanOrEqualToThreshold、GreaterThanThreshold、LessThanThreshold 或 LessThanOrEqualToThreshold 之一

默认值:不适用

:必需 是

--dimensions "key1=value1,key2=value2..."

要为其创建警报的指标的维度。可以两种方式指定维度,且格式可结合使用或互换使用:

  • 每个维度一个选项:--dimensions "key1=value1" --dimensions "key2=value2"

  • 所有维度都在一个选项中: --dimensions "key1=value1,key2=value2"

类型: 映射

有效值:格式为 name=value 的字符串,其中,键是维度的名称,值是维度的值。维度名称和值必须是长度介于 1 到 250 个字符之间的 ANSI 字符串。最多允许 10 个维度。

默认值:不适用

:必需 否

--evaluation-periods VALUE

指标的值将与阈值相比较以确定警报状态的连续周期数。

类型: 整数

有效值:大于零的数字。

默认值:不适用

:必需 是

--metric-name VALUE

要对其报警的指标的名称。

类型: 参数

有效值:长度介于 1 到 250 个字符之间的任何 ANSI 字符。

默认值:不适用

:必需 是

--namespace VALUE

要对其报警的指标的命名空间。有关命名空间的更多信息,请参阅 Amazon 命名空间

类型: 字符串

有效值:长度介于 1 到 250 个字符之间的任何 ANSI 字符。

默认值:不适用

:必需 是

--ok-actions VALUE1,VALUE2,VALUE3...

当此警报从任何其他状态转换为 OK 状态时,要执行的操作(最多五个)。每个操作都被指定为一个Amazon 资源名称 (ARN)。

类型: 字符串

有效值:有效 ARN 标识符。

默认值:不适用

:必需 否

--period VALUE

要对其报警的指标的时间段(以秒为单位)。

类型: 参数

有效值:以秒为单位的数字,是 60 秒的倍数。

默认值:不适用

:必需 是

--statistic VALUE

要对其报警的指标的统计数据。

类型: 枚举

有效值:SampCount、A、Sum、Max或 Max

默认值:不适用

:必需 您必须指定-statistic 或-extenstic。

--extendedstatistic VALUE

要对其报警的指标的百分位数统计数据。

类型: 字符串

有效值:最多两个小数位的任何百分位数 (例如 p95.45)。

默认值:不适用

:必需 您必须指定-statistic 或-extenstic。

--threshold VALUE

数据点与其进行比较以确定警报状态的阈值。

类型: Double

有效值:双精度值 所有值必须是介于 1E-130 和 1E130 之间的数字。

默认值:不适用

:必需 是

--unit VALUE

要对其报警的指标的单位。

类型: 枚举

有效值:下列情况之一:

  • 微秒

  • 毫秒

  • 字节

  • 千字节

  • 兆字节

  • 千兆字节

  • 千吉字节

  • Bits

  • 千位

  • 兆位

  • 千兆位

  • 太位

  • 百分比

  • 计数

  • Bytes/Second

  • 千字节/秒

  • 兆字节/秒

  • 千兆字节/秒

  • 千吉字节/秒

  • Bits/Second

  • 千位/秒

  • 兆位/秒

  • 千兆位/秒

  • 太位/秒

  • 计数/秒

默认值:不适用

:必需 否

--insufficient-data-actions VALUE1,VALUE2,VALUE3...

当此警报从任何其他状态转换为 INSUFFICIENT_DATA 状态时,要执行的操作(最多五个)。每个操作都被指定为一个Amazon 资源名称 (ARN)。

类型: 字符串

有效值:有效 ARN 标识符。

默认值:不适用

:必需 否

常用选项

名称 描述

--aws-credential-file VALUE

文件的位置,Amazon凭证。您可以使用环境变量设置此值。AWS_CREDENTIAL_FILE。如果您定义了环境变量或提供了凭据文件的路径,则该文件必须存在,否则请求将失败。所有 CloudWatch 请求必须使用您的访问密钥 ID 和秘密访问密钥签名。

类型: 字符串

有效值:包含访问密钥 ID 和秘密访问密钥的文件的有效路径。

默认值:使用环境变量AWS_CREDENTIAL_FILE(如果已设置)。

-C, --ec2-cert-file-path VALUE

用于签名请求的 EC2 证书文件的位置。可以使用环境变量EC2_CERT指定此值。

类型: 字符串

有效值:由 Amazon EC2 或 AWS Identity and Access Management 提供的 PEM 文件的有效文件路径。

默认值:使用环境变量EC2_CERT(如果已设置)。

--connection-timeout VALUE

连接超时值 (以秒为单位)。

类型: 整数

有效值:正数。

默认值:30

--delimiter VALUE

显示分隔符(长度)结果时使用的分隔符。

类型: 字符串

有效值:任何字符串。

默认值:逗号 (,)

--headers

如果要显示表格结果或分隔结果,请包括列标题。如果要显示 XML 结果,请从服务请求返回 HTTP 标头(如果适用)。

类型: 标记

有效值:如果存在,则显示标题。

默认值:这些区域有:--headers默认情况下,该选项为 off。

-I, --access-key-id VALUE

将用于对请求签名的访问密钥 ID。此参数必须与 —秘密密钥结合使用,否则会忽略此选项。对 CloudWatch 的所有请求都必须进行签名,否则请求将被拒绝。

类型: 字符串

有效值:有效访问密钥 ID。

默认值:无

-K, --ec2-private-key-file-path VALUE

用于对请求签名的私有密钥。使用公钥/私钥会导致 CLI 使用 SOAP。请求签名时使用公共证书和私有密钥。此参数必须与一起使用。EC2_CERT,否则将忽略此值。环境变量的值EC2_PRIVATE_KEY将在设置时使用,并且未指定此选项。如果环境变量AWS_CREDENTIAL_FILE设置为--aws-credentials-file会使用。对 CloudWatch 的所有请求都必须进行签名,否则请求将被拒绝。

类型: 字符串

有效值:指向有效 ASN.1 私有密钥的路径。

默认值:无

--region VALUE

区域请求被定向到。可以使用环境变量EC2_REGION以指定值。该区域用于创建用于调用 CloudWatch 的 URL,并且必须是有效的 Amazon Web Services (Amazon)区域。

类型: 字符串

有效值:任何Amazon区域,例如,us-east-1。

默认值:us-east-1,除非EC2_REGION环境变量。

S, --secret-key VALUE

将用于对请求进行签名的私有访问密钥以及访问密钥 ID。此参数必须与一起使用。--access-key-id,否则忽略此选项。

类型: 字符串

有效值:您的 访问密钥 ID。

默认值:无

--show-empty-fields

使用 (nil) 作为占位符显示空字段,以指示未请求此数据。

类型: 标记

有效值:无

默认值:默认情况下不显示空字段。

--show-request

显示 CLI 用于调用Amazon。

类型: 标记

有效值:无

默认值:false

--show-table, --show-long, --show-xml, --quiet

指定结果的显示方式:在表中、分隔(长)、XML 或无输出(安静)。这些区域有:--show-table显示以固定列宽形式显示数据的子集;--show-long显示以字符分隔的所有返回值;--show-xml是服务的原始回报;--quiet将抑制所有标准输出。所有选项是互斥的,--show-table--show-long--show-xml, 和--quiet

类型: 标记

有效值:无

默认值:--show-table

-U, --url VALUE

用于联系 CloudWatch 的 URL。您可以使用环境变量设置此值。AWS_CLOUDWATCH_URL。此值与--region来创建预期的 URL。此选项将覆盖服务调用的 URL。

类型: 字符串

有效值:有效的 HTTP 或 HTTPS URL。

默认值:使用AWS_CLOUDWATCH_URL(如果已设置)。

Output

此命令创建或更新与指定指标关联的警报。

亚 Amazon CloudWatch CLI 在 stderr 上显示错误。

Examples

示例请求

此示例创建一个警报,当 EC2 实例的 CPU 利用率超过 90% 的时间达到三个连续的一分钟时,该警报会向主题发布消息。

mon-put-metric-alarm --alarm-name my-alarm --alarm-description "some desc" \ --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 60 --threshold 90 \ --comparison-operator GreaterThanThreshold --dimensions InstanceId=i-abcdef --evaluation-periods 3 \ --unit Percent --alarm-actions arn:aws:sns:us-east-1:1234567890:my-topic

相关主题

Download

相关操作

相关命令