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

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

mon-set-alarm-state

Description

临时更改指定警报的警报状态。在下一个时间段,警报被设为“真”状态。

Syntax

mon-set-alarm-state AlarmName --state-reason value --state-value value [--state-reason-data value] [Common Options]

Options

名称 描述

AlarmName

警报的名称。还可以使用 --alarm-name 设置此值。

类型: 参数

有效值:UTF-8 字符串。

默认值:不适用

:必需 是

--state-reason VALUE

将此警报设置为此状态(人可读)的原因。

类型: 字符串

有效值:长度介于 1 到 1023 个字符之间的 UTF-8 字符串。

默认值:不适用

:必需 是

--state-reason-data VALUE

将此警报设置为此状态的原因。此数据规定为机器可读 JSON。

类型: 字符串

有效值:1 到 4 000 个字符之间的有效机器可读 JSON 字符串。

默认值:不适用

:必需 否

--state-value VALUE

应将警报设置为哪种状态。

类型: 枚举

有效值:警报,正常或不充分 _ 数据

默认值:不适用

:必需 是

常用选项

名称 描述

--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

当请求成功时,此命令暂时更改警报的状态并显示 OK-Set alarm state value

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

Examples

示例请求

此示例将名为 my-alarm 的警报的状态设置为 OK。

mon-set-alarm-state --alarm-name my-alarm --state OK

相关主题

Download

相关操作

相关命令