mon-describe-alarms
説明
指定したアラームに関する情報を取得します。アラーム名を指定しないと、すべてのアラームの情報が返されます。アラーム名のプレフィックス、アラームの状態、またはアクションのプレフィックスだけでも、アラームを特定することができます。
構文
mon-describe-alarms
[AlarmNames [
AlarmNames
...]] [--action-prefix value
] [--alarm-name-prefix value
]
[--state-value value
] [Common Options]
オプション
名前 | 説明 |
---|---|
|
アラームの名前。この値は タイプ: 引数 有効値: 既存のアラーム名。それ以外では応答は返されません。 デフォルト: N/A。デフォルトではすべてのアラームが表示されます。 必須:いいえ |
|
アクション名のプレフィックス。 タイプ: 引数 有効値: 既存のアクション名のプレフィックス (ARN 形式)。 デフォルト: N/A。デフォルトでは最初のアクションが表示されます。 必須:いいえ |
|
アラーム名のプレフィックス。 タイプ: 引数 有効値: 既存のアラーム名のプレフィックス。 デフォルト: N/A 必須:いいえ |
|
アラームの状態。 タイプ: 列挙法 有効値: OK、ALARM、または INSUFFICIENT_DATA デフォルト: すべてのアラーム状態 必須:いいえ |
一般的なオプション
名前 | 説明 |
---|---|
|
AWS 認証情報を含むファイルの場所。環境変数 型: 文字列 有効な値: アクセスキー ID とシークレットアクセスキーを含むファイルへの有効なパス。 デフォルト: 設定されている場合は、環境変数 |
|
リクエストに署名するための EC2 証明書ファイルの場所。環境変数 型: 文字列 有効な値: Amazon EC2 または AWS Identity and Access Management によって提供される PEM ファイルへの有効なファイルパス。 デフォルト: 設定されている場合は、環境変数 |
|
接続タイムアウト値 (秒)。 型: 整数 有効な値: 任意の正の整数。 デフォルト: 30 |
|
長い結果を区切って表示する際に使用する区切り記号。 型: 文字列 有効な値: 任意の文字列。 デフォルト: コンマ(,) |
|
表形式の結果または区切られた結果を表示する場合に、列ヘッダーを含めます。XML 形式の結果を表示する場合に、サービスリクエストから HTTP ヘッダーを返します (該当する場合)。 タイプ: フラグ 有効な値: 存在する場合は、ヘッダーを表示します。 デフォルト: |
|
リクエストの署名で、シークレットキーと組み合わせて使用するアクセスキー ID。これは、––secret-key と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。CloudWatch へのすべてのリクエストには署名が必要です。署名がないと、リクエストは拒否されます。 型: 文字列 有効な値: 有効なアクセスキー ID。 デフォルト: なし |
|
リクエストに署名するために使用されるプライベートキー。パブリック/プライベートキーを使用すると、CLI が SOAP を使用します。リクエストは、パブリック証明書とプライベートキーを使用して署名されます。このパラメータは、 型: 文字列 有効な値: 有効な ASN.1 プライベートキーへのパス。 デフォルト: なし |
|
リクエストの送信先のリージョン。環境変数 型: 文字列 有効な値: 任意の AWS リージョン (例: us-east-1) デフォルト: 環境変数 |
|
リクエストの署名で、アクセスキー ID と組み合わせて使用するシークレットアクセスキー。このパラメータは、 型: 文字列 有効な値: アクセスキー ID デフォルト: なし |
|
プレースホルダーとして (nil) を使用して空のフィールドを表示し、このデータがリクエストされなかったことを示します。 タイプ: フラグ 有効な値: なし デフォルト: デフォルトでは、空のフィールドは表示されません。 |
|
CLI が AWS の呼び出しに使用する URL を表示します。 タイプ: フラグ 有効な値: なし デフォルト: false |
|
結果の表示形式として、表形式、区切り形式 (長い)、XML 形式、または出力なし (非表示) を指定します。 タイプ: フラグ 有効な値: なし デフォルト: |
|
CloudWatch への接続に使用する URL。環境変数 型: 文字列 有効な値:有効な HTTP または HTTPS 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 – 統計 (Average、Minimum、Maximum、Sum、SampleCount)。
-
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