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

mon-describe-alarm-history

说明

检索指定警报的历史记录。您可以按日期范围或项目类型筛选警报。如果不指定警报名称,Amazon CloudWatch 会返回所有警报的历史记录。

注意

Amazon CloudWatch 将活动警报和已删除警报的历史记录保存两个星期。

语法

mon-describe-alarm-history [AlarmNames [AlarmNames ...]] [--end-date value] [--history-item-type value] [--start-date value] [Common Options]

选项

名称 说明

AlarmName AlarmNames

警报的名称,用空格分隔。如果不指定警报名称,此命令会返回所有警报的历史记录。还可以使用 --alarm-name 设置此值。

类型:参数

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

默认值:不适用

必需:否

--end-date VALUE

历史记录的日期范围的结束日期。

类型:日期

有效值:YYYY-MM-DD 格式的日期。

默认值:当前日期。

必需:否

--history-item-type VALUE

要检索的历史记录项的类型。默认情况下,返回所有类型。

类型:枚举

有效值:ConfigurationUpdate、StateUpdate 或 Action

默认值:返回所有类型。

必需:否

--start-date VALUE

历史记录的日期范围的开始日期。默认情况下,它会延伸到所有可用历史记录。

类型:日期

有效值:YYYY-MM-DD 格式的日期。

默认值:所有可用历史记录。

必需:否

常用选项

名称 说明

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

输出

此命令将返回包含以下内容的表格:

  • ALARM - 警报名称。

  • TIMESTAMP - 时间戳。

  • TYPE - 事件类型,ConfigurationUpdate、StateUpdate 和 Action 之一。

  • SUMMARY - 历史记录事件的人可读汇总。

  • DATA - 有关事件的机器可读 JSON 格式的详细数据。该列仅在 --show-long 视图中显示。

Amazon CloudWatch CLI 在 stderr 上显示错误。

示例

示例请求

此示例描述 my-alarm 警报的所有历史记录项。

mon-describe-alarm-history--alarm-name my-alarm --headers

以下是该命令的示例输出。

ALARM TIMESTAMP TYPE SUMMARY my-alarm 2013-05-07T18:46:16.121Z Action Published a notification to arn:aws:sns:... my-alarm 2013-05-07T18:46:16.118Z StateUpdate Alarm updated from INSUFFICIENT_DATA to OK my-alarm 2013-05-07T18:46:07.362Z ConfigurationUpdate Alarm "my-alarm" created

相关主题

下载

相关操作

相关命令