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

mon-put-metric-alarm

说明

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

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

注意

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

语法

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]

选项

名称 说明

AlarmName

要更新或创建的警报的名称。该名称在 AWS 账户内必须是唯一的。还可以使用 --alarm-name 设置此值。

类型:参数

有效值:UTF-8 字符串。

默认值:不适用

必需:是

--actions-enabled VALUE

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

类型:布尔值

有效值: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 策略。

如果您使用的是用 AWS Security Token Service (AWS STS) 授予的临时安全证书,则无法使用警报操作来停止或终止 Amazon EC2 实例。

类型:字符串

有效值:Amazon SNS 主题、Auto Scaling 策略的 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

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

类型:字符串

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

默认值:不适用

必需:是

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

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

类型:字符串

有效值:有效 ARN 标识符。

默认值:不适用

必需:否

--period VALUE

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

类型:参数

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

默认值:不适用

必需:是

--statistic VALUE

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

类型:枚举

有效值:SampleCount、Average、Sum、Minimum 或 Maximum

默认值:不适用

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

--extendedstatistic VALUE

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

类型:字符串

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

默认值:不适用

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

--threshold VALUE

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

类型:双精度

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

默认值:不适用

必需:是

--unit VALUE

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

类型:枚举

有效值:下列值之一:

  • Seconds

  • 微秒

  • 毫秒

  • 字节

  • 千字节

  • 兆字节

  • 千兆字节

  • 千吉字节

  • Bits

  • 千位

  • 兆位

  • 千兆位

  • 太位

  • 百分比

  • Count

  • Bytes/Second

  • 千字节/秒

  • 兆字节/秒

  • 千兆字节/秒

  • 千吉字节/秒

  • Bits/Second

  • 千位/秒

  • 兆位/秒

  • 千兆位/秒

  • 太位/秒

  • Count/Second

默认值:不适用

必需:否

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

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

类型:字符串

有效值:有效 ARN 标识符。

默认值:不适用

必需:否

常用选项

名称 说明

--aws-credential-file VALUE

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

类型:字符串

有效值:包含访问密钥 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 选项默认处于关闭状态。

-I, --access-key-id VALUE

将与秘密密钥结合使用对请求进行签名的访问密钥 ID。它必须与 --secret-key 结合使用,否则将忽略该选项。必须对所有 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 (AWS) 区域。

类型:字符串

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

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

S, --secret-key VALUE

将与访问密钥 ID 结合使用来对请求进行签名的秘密访问密钥。此参数必须与 --access-key-id 结合使用,否则将忽略该选项。

类型:字符串

有效值:访问密钥 ID。

默认值:无

--show-empty-fields

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

类型:标志

有效值:无

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

--show-request

显示 CLI 用于调用 AWS 的 URL。

类型:标志

有效值:无

默认值: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 中指定的值(如果已设置)。

输出

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

Amazon CloudWatch CLI 在 stderr 上显示错误。

示例

示例请求

此示例创建一个警报,当 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

相关主题

下载

相关操作

相关命令