mon-describe-alarms-for-metric - Amazon CloudWatch
説明構文オプション一般的なオプション出力例関連トピック

mon-describe-alarms-for-metric

説明

指定したメトリクスに関連付けられているアラームに関する情報を取得します。

構文

mon-describe-alarms-for-metric --metric-name value --namespace value [--dimensions "key1=value1,key2=value2..."] [--period value] [--statistic value] [--extendedstatistic value] [--unit value] [Common Options]

オプション

名前 説明

--dimensions - "key1=value1,key2=value2...

メトリクスに関連付けられているディメンション。ディメンションは 2 つの方法で指定でき、形式を組み合わせて、あるいは互換的に使用することができます。

  • 1 ディメンションに 1 つのオプションの場合: --dimensions "key1=value1" --dimensions "key2=value2"

  • 1 つのオプションにまとめた場合: --dimensions "key1=value1,key2=value2"

タイプ: マップ

有効値: name=value 形式の文字列。ここで、key はディメンション名、value はディメンションの値です。ディメンション名と値は、文字長が 1 から 250 の ANSI 文字列である必要があります。最大 10 ディメンションが許可されています。

デフォルト: N/A

必須: いいえ

--metric-name VALUE

検索するアラームに関連付けられているメトリクスの名前。

タイプ: 引数

有効値: 文字長が 1 から 255 の有効なメトリクス名

デフォルト: N/A

必須: はい

--namespace VALUE

アラームに関連付けられているメトリクスの名前空間。名前空間の詳細については、AWS の名前空間を参照してください。

型: 文字列

有効値: 文字長が 1 から 250 の有効な名前空間

デフォルト: N/A

必須: はい

--period VALUE

アラームをフィルタリングする期間です。この期間にメトリクスを評価するアラームのみが結果に含まれます。期間が指定されていない場合、全期間のアラームが含まれます。

タイプ: 引数

有効値: 秒数、60 の倍数。

デフォルト: N/A

必須: いいえ

--statistic VALUE

アラームをフィルタリングする統計です。指定した統計のアラームのみが含まれます。このパラメータを指定しない限り、すべての統計のアラームが含まれます。

タイプ: 列挙法

有効値: SampleCount、Average、Sum、Minimum、または Maximum

デフォルト: N/A

必須: いいえ

--extendedstatistic VALUE

アラームをフィルタリングするパーセンタイル統計です。指定した統計のアラームのみが含まれます。このパラメータを指定しない限り、すべての統計のアラームが含まれます。

型: 文字列

有効な値: 小数点以下 2 桁までの任意のパーセンタイル (p95.45 など)。

デフォルト: N/A

必須: いいえ

--unit VALUE

アラームをフィルターする単位。指定した統計のアラームのみが含まれます。単位を指定しないと、すべての単位のアラームが含まれます。単位が指定されてないアラームを検索する場合は、必ずこのオプションを省略してください。

タイプ: 列挙法

有効な値: 以下のいずれかです。

  • [Seconds] (秒)

  • マイクロ秒

  • ミリ秒

  • バイト

  • Kilobytes

  • Megabytes

  • Gigabytes

  • Terabytes

  • Bits

  • Kilobits

  • Megabits

  • Gigabits

  • Terabits

  • 割合 (%)

  • Count (カウント)

  • Bytes/Second

  • Kilobytes/Second

  • Megabytes/Second

  • Gigabytes/Second

  • Terabytes/Second

  • Bits/Second

  • Kilobits/Second

  • Megabits/Second

  • Gigabits/Second

  • Terabits/Second

  • Count/Second

  • なし

デフォルト: N/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 または AWS Identity and Access Management によって提供される PEM ファイルへの有効なファイルパス。

デフォルト: 設定されている場合は、環境変数 EC2_CERT を使用します。

--connection-timeout VALUE

接続タイムアウト値 (秒)。

型: 整数

有効な値: 任意の正の整数。

デフォルト: 30

--delimiter VALUE

長い結果を区切って表示する際に使用する区切り記号。

型: 文字列

有効な値: 任意の文字列。

デフォルト: コンマ（,）

--headers

表形式の結果または区切られた結果を表示する場合に、列ヘッダーを含めます。XML 形式の結果を表示する場合に、サービスリクエストから HTTP ヘッダーを返します (該当する場合)。

タイプ: フラグ

有効な値: 存在する場合は、ヘッダーを表示します。

デフォルト: --headers オプションは、デフォルトでオフになっています。

-I, --access-key-id VALUE

リクエストの署名で、シークレットキーと組み合わせて使用するアクセスキー ID。これは、––secret-key と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。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)

デフォルト: 環境変数 EC2_REGION が設定されている場合を除き、us-east-1

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 を使用して、この値を設定できます。この値は有効な URL を作成するために --region と組み合わせて使用されます。このオプションは、サービス呼び出しの URL をオーバーライドします。

型: 文字列

有効な値:有効な HTTP または HTTPS URL。

デフォルト: 設定されている場合は、AWS_CLOUDWATCH_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 でエラーを表示します。

例

リクエストの例

この例では、特定のメトリクスのアラームを記述しています。

mon-describe-alarms-for-metric--metric-name CPUUtilization --namespace AWS/EC2  --dimensions InstanceId=i-abcdef

このコマンドの出力例は次のとおりです。

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  80.0

関連トピック

ダウンロード

関連アクション

関連コマンド