mon-describe-alarm-history
説明
指定したアラームの履歴を取得します。日付範囲または項目タイプでアラームをフィルターできます。アラーム名を指定しないと、Amazon CloudWatch はすべてのアラームの履歴を返します。
注記
Amazon CloudWatch は、アクティブなアラームと削除されたアラームの履歴を 2 週間保持します。
構文
mon-describe-alarm-history
[AlarmNames [
AlarmNames
...]] [--end-date value
] [--history-item-type value
]
[--start-date value
] [Common Options]
オプション
名前 | 説明 |
---|---|
|
アラームの名前 (名前ごとにスペースで区切ります)。アラーム名を指定しないと、すべてのアラームの履歴が返されます。この値は タイプ: 引数 有効値: 文字長が 1 から 255 の文字列 デフォルト: N/A 必須:いいえ |
|
履歴の日付範囲の最終日。 タイプ: 日付 有効値: 日付 (YYYY-MM-DD 形式) デフォルト: 現在の日付 必須:いいえ |
|
取得する履歴項目のタイプ。デフォルトでは、すべてのタイプが返されます。 タイプ: 列挙法 有効値: ConfigurationUpdate、StateUpdate、または Action デフォルト: すべてのタイプが返されます。 必須:いいえ |
|
履歴の日付範囲の開始日。デフォルトでは、すべての利用可能な履歴を含む範囲の開始日です。 タイプ: 日付 有効値: 日付 (YYYY-MM-DD 形式) デフォルト: すべての利用可能な履歴 必須:いいえ |
一般的なオプション
名前 | 説明 |
---|---|
|
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 – アラーム名。
-
TIMESTAMP – タイムスタンプ。
-
TYPE – イベントタイプ。ConfigurationUpdate、StateUpdate、Action のいずれかです。
-
SUMMARY – 人間が判読できる履歴イベントの概要。
-
DATA – マシンが読み取り可能な JSON 形式のイベントの詳細データ。この列は ––show-long ビューにのみ表示されます。
Amazon CloudWatch CLI は、stderr でエラーを表示します。
例
リクエストの例
この例では、アラーム my-alarm の全履歴項目を記述しています。
mon-describe-alarm-history--alarm-name my-alarm --headers
このコマンドの出力例は次のとおりです。
ALARM TIMESTAMP TYPE SUMMARY my-alarm 2013-05-07T18:46:16.121Z Action Published a notification to arn:aws:sns:... my-alarm 2013-05-07T18:46:16.118Z StateUpdate Alarm updated from INSUFFICIENT_DATA to OK my-alarm 2013-05-07T18:46:07.362Z ConfigurationUpdate Alarm "my-alarm" created