mon-describe-alarms - Amazon CloudWatch
描述语法Options常用选项输出示例相关 主题

mon-describe-alarms

描述

获取有关指定警报的信息。如果不指定警报名称，此命令会返回有关所有警报的信息。只能使用警报名称前缀、警报状态或操作前缀检索警报。

语法

mon-describe-alarms [AlarmNames [AlarmNames ...]] [--action-prefix value] [--alarm-name-prefix value] [--state-value value] [Common Options]

Options

名称 描述

AlarmNames AlarmNames

警报的名称。还可以使用 --alarm-name 设置此值。您可以多次指定该选项。

类型：参数

有效值：现有警报名称，否则不会返回任何响应。

默认值：不适用，默认情况下显示所有警报。

必需：否

--action-prefix VALUE

操作名称的前缀。

类型：参数

有效值：现有操作名称的前缀，采用 ARN 格式。

默认值：不适用，默认情况下显示第一个操作。

必需：否

--alarm-name-prefix VALUE

警报名称的前缀。

类型：参数

有效值：现有警报名称的前缀。

默认值：不适用

必需：否

--state-value VALUE

警报的状态。

类型：枚举

有效值：OK、ALARM 或 INSUFFICIENT_DATA

默认值：所有警报状态。

必需：否

常用选项

名称 描述

--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 将与私有密钥共同用于签署请求。其必须与私有密钥结合使用，否则此选项将被忽略。对 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，并且必须是有效的亚马逊云科技 (AWS）区域。

类型：字符串

有效值：任意 AWS 区域，例如 us-east-1。

默认值：除非 EC2_REGION 环境变量已设置，否则为 us-east-1。

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 - 告警名称。

  • DESCRIPTION - 告警描述。该列仅在 --show-long 视图中显示。

  • STATE - 告警状态。

  • STATE_REASON - 人类可读的状态原因。该列仅在 --show-long 视图中显示。

  • STATE_REASON_DATA - 机器可读的状态原因（JSON 格式）。该列仅在 --show-long 视图中显示。

  • ENABLED - 启用或禁用操作。该列仅在 --show-long 视图中显示。

  • OK_ACTIONS - 在 OK（正常）状态下执行的操作。该列仅在 --show-long 视图中显示。

  • ALARM_ACTIONS - 在 ALARM（告警）状态下执行的操作。

  • INSUFFICIENT_DATA_ACTIONS - 在 INSUFFICIENT_DATA（数据不足）状态下执行的操作。该列仅在 --show-long 视图中显示。

  • NAMESPACE - 指标的命名空间。

  • METRIC_NAME - 指标的名称。

  • DIMENSIONS - 指标维度。该列仅在 --show-long 视图中显示。

  • PERIOD - 时间段。

  • STATISTIC - 统计数据（平均值、最小值、最大值、总数和样本数）。

  • EXTENDEDSTATISTIC - 百分位数统计数据。

  • UNIT - 单位。该列仅在 --show-long 视图中显示。

  • EVAL_PERIODS - 用于评估指标的时间段数。

  • COMPARISON - 比较运算符。

  • THRESHOLD - 阈值。

Amazon CloudWatch CLI 在 stderr 上显示错误。

示例

示例请求

此示例描述其名称以 my-alarm 开头的所有警报。

mon-describe-alarms --alarm-name-prefix my-alarm --headers

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

ALARM      STATE ALARM_ACTIONS  NAMESPACE  METRIC_NAME    PERIOD  STATISTIC  EVAL_PERIODS  COMPARISON            THRESHOLD
my-alarm1  OK    arn:aws:sns:.. AWS/EC2    CPUUtilization 60      Average    3             GreaterThanThreshold  100.0
my-alarm2  OK    arn:aws:sns:.. AWS/EC2    CPUUtilization 60      Average    5            
GreaterThanThreshold  80o.0

相关 主题

下载

相关操作

相关命令