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

mon-get-stats

説明

指定した統計に関する時系列データを取得します。

注記

mon-put-data コマンドで新しいメトリクスを作成した場合、mon-get-stats コマンドを用いてその新規メトリクスの統計を取得できるようになるまで最大 2 分かかります。ただし、mon-list-metrics コマンドを用いて取得したメトリクスのリストに新規メトリクスが表示されるまで最大 15 分かかることがあります。

構文

mon-get-stats MetricName --namespace value --statistics value[,value...] [--dimensions "key1=value1,key2=value2..." ] [--end-time value] [--period value] [--start-time value] [--unit value] [Common Options]

オプション

名前 説明

MetricName

メトリクスの名前。この値は --metric-name を使用して設定することもできます。

タイプ: 引数

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

デフォルト: N/A

必須: はい

--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

必須：いいえ

--end-time VALUE

返されたデータポイントに許容される最新のタイムスタンプ。終了時間は含まれません。タイムスタンプは、ISO8601 複合形式を使用して指定します。たとえば、日時が 2013 年 7 月 30 日 12:30:00 (PST) の場合、2013-07-30T12:30:00-07:00、または UTC で 2013-07-30T19:30:00Z と表記されます。CloudWatch が返すことのできる最小単位は 1 分です。このため、すべてのタイムスタンプは分単位に切り下げて表示されます。

タイプ: 引数

有効値: タイムゾーンオフセットまたは UTC 表示による、ISO8601 形式で表記された有効なタイムスタンプ

デフォルト: 現在の日時

必須：いいえ

-n, --namespace VALUE

メトリクスの名前空間。名前空間の詳細については、AWS の名前空間を参照してください。

型: 文字列

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

デフォルト: N/A

必須: はい

--period VALUE

取得する統計の詳細度 (秒単位)。期間は少なくとも 60 秒で、60 の倍数であることが必要です。

タイプ: 引数

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

デフォルト: 60 秒

必須：いいえ

-s, --statistics VALUE1,VALUE2,VALUE3...

指定したメトリクスで返される統計。

タイプ: 列挙法

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

デフォルト: N/A

必須: はい

--start-time VALUE

返されたデータポイントに許容される最初のタイムスタンプを指定します。開始時間は含まれます。タイムスタンプは、ISO8601 複合形式を使用して指定します。たとえば、日時が 2013 年 7 月 30 日 12:30:00 (PST) の場合、2013-07-30T12:30:00-07:00、または UTC で 2013-07-30T19:30:00Z と表記されます。CloudWatch が返すことのできる最小単位は 1 分です。このため、すべてのタイムスタンプは分単位に切り下げて表示されます。

タイプ: 引数

有効値: タイムゾーンオフセットまたは UTC 表示による、ISO8601 形式で表記された有効なタイムスタンプ

デフォルト: 現在時刻の 1 時間前

必須：いいえ

--unit VALUE

取得するメトリクスの単位。メトリクスが複数の単位でレポートされる場合がありますが、このオプションを使用すると、特定の単位でメトリクスを取得することができます。単位を要求しない場合、全単位が返されます。メトリクスが 1 つの単位のみでレポートされている場合は効果がありません。

タイプ: 列挙法

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

  • [秒]

  • マイクロ秒

  • ミリ秒

  • バイト

  • Kilobytes

  • Megabytes

  • Gigabytes

  • Terabytes

  • Bits

  • Kilobits

  • Megabits

  • Gigabits

  • Terabits

  • 割合 (%)

  • カウント

  • 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 で指定した値を使用します。

出力

このコマンドで、以下の値を含む表が返されます。

  • Time – メトリクスを取得した時間。

  • SampleCount – このカラムの記述はありません。

  • Average – 平均値。

  • Sum – 合計値。

  • Minimum – 最小の監視値。

  • Maximum – 最大の監視値。

  • Unit – メトリクスの単位。

Amazon CloudWatch CLI は、stderr でエラーを表示します。

例

リクエストの例

この例では、EC2 インスタンス i-c07704a9 の平均値、最小、最大 CPU 使用率を 1 時間単位で返しています。

mon-get-stats CPUUtilization --start-time 2013-02-14T23:00:00.000Z --end-time 2013-03-14T23:00:00.000Z --period 3600 --statistics "Average,Minimum,Maximum" --namespace "AWS/EC2" --dimensions "InstanceId=i-c07704a9"

Samples メトリクスと Average メトリクスの出力 (1 分単位) 例は以下のとおりです。

Time                 Samples  Average  Unit   
2013-05-19 00:03:00  2.0      0.19     Percent
2013-05-19 00:04:00  2.0      0        Percent
2013-05-19 00:05:00  2.0      0        Percent
2013-05-19 00:06:00  2.0      0        Percent
2013-05-19 00:07:00  2.0      0        Percent
2013-05-19 00:08:00  2.0      0        Percent
2013-05-19 00:09:00  2.0      0        Percent
2013-05-19 00:10:00  2.0      0        Percent
2013-05-19 00:11:00  2.0      0        Percent
2013-05-19 00:12:00  2.0      0.195    Percent
2013-05-19 00:13:00  2.0      0.215    Percent
...

リクエストの例

この例では、EC2 フリート全体の CPU 使用率を返しています。

mon-get-stats CPUUtilization --start-time 2013-02-14T23:00:00.000Z --end-time 2013-03-14T23:00:00.000Z --period 3600 --statistics "Average,Minimum,Maximum" --namespace "AWS/EC2"

リクエストの例

この例では、特定ユーザーの MyService のテストスタックに対して行われる平均値、最小、最大リクエスト回数を 1 時間単位で返しています。

mon-get-stats RequestCount --start-time 2013-11-24T23:00:00.000Z --end-time 2013-11-25T23:00:00.000Z --period 3600 --statistics "Average,Minimum,Maximum" --namespace "MyService" --dimensions "User=SomeUser,Stack=Test"

リクエストの例

この例では、「MyService」全体の RequestCount 統計を示しています。

mon-get-stats RequestCount --start-time 2013-11-24T23:00:00.000Z --end-time 2013-11-25T23:00:00.000Z --period 3600 --statistics "Average,Minimum,Maximum,SampleCount" --namespace "MyService"

関連トピック

ダウンロード

関連アクション

関連コマンド