mon-put-metric-alarm - Amazon CloudWatch
描述語法選項常用選項輸出範例相關主題

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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 Resource Name (ARN) 指定。您可以使用警示動作來發佈到 Amazon SNS 主題、啟動 Amazon EC2 Auto Scaling 政策，或停止、終止或復原 Amazon EC2 執行個體。

注意

如果您使用 AWS Identity and Access Management (IAM) 帳戶來建立或修改警示，您必須具有下列 Amazon EC2 許可：

  • ec2:DescribeInstanceStatus 和 ec2:DescribeInstances 用於 Amazon EC2 執行個體狀態指標的所有警示。

  • ec2:StopInstances：針對有停止動作的警示。

  • ec2:TerminateInstances：針對有終止動作的警示。

  • ec2:DescribeInstanceRecoveryAttribute 和 ec2: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 主題的 ARN、Auto Scaling 政策，或用於停止、終止或復原 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 格式的字串，其中 key 是維度的名稱，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 Resource Name (ARN) 指定。

類型：字串

有效值：有效的 ARN 識別符。

預設：無

必要：否

--period VALUE

據以發出警示的指標期間 (以秒為單位)。

類型：引數

有效值：60 秒的倍數 (以秒為單位)。

預設：無

必要：是

--statistic VALUE

據以發出警示的指標統計。

類型：列舉

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

預設：無

必要：您必須指定 --statistic 或 --extendedstatistic。

--extendedstatistic VALUE

據以發出警示的指標百分位數統計。

類型：字串

有效值：任何百分位數，最多使用兩位小數 (例如，p95.45)。

預設：無

必要：您必須指定 --statistic 或 --extendedstatistic。

--threshold VALUE

與資料點相互比較以判斷警示狀態的閾值。

類型：Double

有效值：double 值。所有值必須是 1E-130 和 1E130 之間的數字。

預設：無

必要：是

--unit VALUE

據以發出警示的指標單位。

類型：列舉

有效值：下列其中一個：

  • 秒鐘

  • 微秒

  • 毫秒

  • 位元組

  • KB

  • MB

  • GB

  • TB

  • 位元

  • 千位元數

  • 百萬位元數

  • 十億位元數

  • 兆位元數

  • 百分比

  • 計數

  • 位元組/秒

  • KB/秒

  • MB/秒

  • GB/秒

  • TB/秒

  • 位元/秒

  • 千位元數/秒

  • 百萬位元數/秒

  • 十億位元數/秒

  • 兆位元數/秒

  • 計數/秒

  • 無

預設：無

必要：否

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

當此警示從任何其他狀態轉換為 INSUFFICIENT_DATA 狀態時要執行的動作 (最多五個)。每個動作都以 Amazon Resource Name (ARN) 指定。

類型：字串

有效值：有效的 ARN 識別符。

預設：無

必要：否

常用選項

名稱 描述

--aws-credential-file VALUE

檔案與登入 AWS 資料的位置。您可以使用環境變數 AWS_CREDENTIAL_FILE 來設定這個值。如果您定義環境變數或提供憑證檔案的路徑，則檔案必須存在或請求失敗。所有 CloudWatch 請求必須使用存取金鑰 ID 和私密存取金鑰簽署。

類型：字串

有效值：檔案的有效路徑，包含存取金鑰 ID 和私密存取金鑰。

預設：使用環境變數 AWS_CREDENTIAL_FILE (如果設定)。

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

用於簽署請求的 EC2 憑證檔案位置。您可使用環境變數 EC2_CERT 來指定這個值。

類型：字串

有效值：Amazon EC2 或 所提供 PEM 檔案的有效檔案路徑 AWS Identity and Access Management。

預設：使用環境變數 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，並且必須是有效的 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

相關主題

下載

相關動作

相關命令