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

# mon-describe-alarms
<a name="cli-mon-describe-alarms"></a>

## Description
<a name="w2aab9c23b3"></a>

取得指定警示的相關資訊。如果您不指定警示名稱，此命令會傳回所有警示的相關資訊。您可以只使用警示名稱字首、警示狀態或動作字首來擷取警示。

## 語法
<a name="w2aab9c23b5"></a>

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

## 選項
<a name="w2aab9c23b7"></a>


| 名稱 | 描述 | 
| --- | --- | 
|  `AlarmNames` `AlarmNames`  |  警示的名稱。您也可以使用 `--alarm-name` 設定此值。您可以多次指定此選項。 類型：引數 有效值：現有的警示名稱，否則不會傳回任何回應。 預設：無，在預設情況下會顯示所有警示。 必要：否  | 
|   `--action-prefix` `VALUE`   |  動作名稱的字首。 類型：引數 有效值：現有動作名稱的字首 (ARN 格式)。 預設：無，在預設情況下會顯示第一個動作。 必要：否  | 
|   `--alarm-name-prefix` `VALUE`   |  警示名稱的字首。 類型：引數 有效值：現有警示名稱的字首。 預設：無 必要：否  | 
|   `--state-value` `VALUE`   |  警示的狀態。 類型：列舉 有效值：OK、ALARM 或 INSUFFICIENT\$1DATA 預設：所有警示狀態。 必要：否  | 

## 常用選項
<a name="w2aab9c23b9"></a>


| 名稱 | 描述 | 
| --- | --- | 
|  `--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` 中指定的值 (如果設定)。  | 

## Output
<a name="w2aab9c23c11"></a>

此命令會傳回一個表格，其中包含下列項目：
+ ALARM - 警示名稱。
+ DESCRIPTION - 警示說明。此欄只出現在 --show-long 檢視中。
+ STATE - 警示狀態。
+ STATE\$1REASON - 人類可讀取的狀態原因。此欄只出現在 --show-long 檢視中。
+ STATE\$1REASON\$1DATA - 機器可讀取的狀態原因 (JSON 格式)。此欄只出現在 --show-long 檢視中。
+ ENABLED - 啟用或停用動作。此欄只出現在 --show-long 檢視中。
+ OK\$1ACTIONS - 在 OK 狀態上執行的動作。此欄只出現在 --show-long 檢視中。
+ ALARM\$1ACTIONS - 在 ALARM (警示) 狀態上執行的動作。
+ INSUFFICIENT\$1DATA\$1ACTIONS - 在 INSUFFICIENT\$1DATA 狀態上執行的動作。此欄只出現在 --show-long 檢視中。
+ NAMESPACE - 指標的命名空間。
+ METRIC\$1NAME - 指標的名稱。
+ DIMENSIONS - 指標維度。此欄只出現在 --show-long 檢視中。
+ PERIOD - 期間。
+ STATISTIC - 統計資料 (平均值、最小值、最大值、總和及樣本計數)。
+ EXTENDEDSTATISTIC - 百分位數統計。
+ UNIT - 單位。此欄只出現在 --show-long 檢視中。
+ EVAL\$1PERIODS - 評估指標的期間數。
+ COMPARISON - 比較運算子。
+ THRESHOLD - 閾值。

Amazon CloudWatch CLI 會在 stderr 上顯示錯誤。

## 範例
<a name="w2aab9c23c13"></a>

### 範例請求
<a name="w2aab9c23c13b2"></a>

此範例說明名稱開頭為 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
```

## 相關主題
<a name="w2aab9c23c15"></a>

### 下載
<a name="w2aab9c23c15b2"></a>
+ [設定命令列介面](SetupCLI.md)

### 相關動作
<a name="w2aab9c23c15b4"></a>
+ [DescribeAlarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html)

### 相關命令
<a name="w2aab9c23c15b6"></a>
+  [mon-describe-alarm-history](cli-mon-describe-alarm-history.md) 
+  [mon-describe-alarms-for-metric](cli-mon-describe-alarms-for-metric.md)