# mon-list-metrics
## 説明
ご使用の AWS アカウントに関連付けられているメトリクスの名前、名前空間、ディメンションを一覧表示します。メトリクスは、名前、名前空間、ディメンションを任意に組み合わせてフィルターできます。フィルターを指定しない場合、その属性に一致する可能性のあるものすべてが返されます。
**注記**
`mon-put-data` の呼び出しで追加した新規メトリクスの名前、名前空間、ディメンションが、mon-list-metrics コマンドで返されるレポートに表示されるまで最大 15 分かかることがあります。`mon-put-data`、またはその他の方法で置かれたデータポイントが、`mon-get-statistics` で使用できるようになるまでには、5 分かかりません。
## 構文
****mon-list-metrics** [--dimensions "key1={{value1}},key2={{value2}}..."] [--metric-name {{value}}] [--namespace {{value}}] [Common Options] **
## オプション
| 名前 | 説明 |
| --- | --- |
| -d, --dimensions `"key1=value1,key2=value2..."` | 取得するメトリクスのディメンション。ディメンションは 2 つの方法で指定でき、形式を組み合わせて、あるいは互換的に使用することができます。[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/cli/cli-mon-list-metrics.html)
ディメンションが指定されていない場合、ディメンションのフィルタリングは行われません。その他のリクエストされているフィルターはすべて適用されます。リクエストしたメトリクスにはほかのディメンションもあるかもしれませんが、指定したすべてのディメンションを持つメトリクスが結果に表示されます。
タイプ: マップ
有効値: name=value 形式の文字列。ここで、key はディメンション名、value はディメンションの値です。ディメンション名と値は、文字長が 1 から 250 の ANSI 文字列である必要があります。最大 10 ディメンションが許可されています。
デフォルト: N/A
必須: いいえ |
| `-m, --metric-name` `VALUE` | メトリクスの名前。メトリクス名を結果に表示するには、それがリクエストされたメトリクス名と完全に一致している必要があります。メトリクス名を指定しないと、フィルター処理は行われません。他のすべてのリクエストされているフィルターが適用されます。
タイプ: シンプル
有効値: 文字長が 1 から 250 の有効なメトリクス名
デフォルト: N/A
必須: いいえ |
| `-n, --namespace` ` VALUE` | メトリクスのフィルターに使用する名前空間。名前空間の詳細については、[AWS の名前空間](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/aws-namespaces.html)を参照してください。
タイプ: 文字列
有効値: 文字長が 1 から 250 の有効な名前空間
デフォルト: 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` で指定した値を使用します。 |
## Output
このコマンドで、以下の値を含む表が返されます。
+ Metric Name – このメトリクスに付けられたメトリクス名
+ Namespace – このメトリクスに関連付けられている名前空間
+ Dimensions – このメトリクスに関連付けられているディメンションの名前と値。
Amazon CloudWatch CLI は、stderr でエラーを表示します。
## 例
### リクエスト例
この例では、全メトリクスの一覧が返されます。
```
mon-list-metrics
```
mon-list-metrics への呼び出しの出力例は以下のとおりです。
```
Metric Name Namespace Dimensions
CPUUtilization AWS/EC2 {InstanceId=i-e7e48a8e}
CPUUtilization AWS/EC2 {InstanceId=i-231d744a}
CPUUtilization AWS/EC2 {InstanceId=i-22016e4b}
CPUUtilization AWS/EC2 {InstanceId=i-b0345cd9}
CPUUtilization AWS/EC2 {InstanceId=i-539dff3a}
CPUUtilization AWS/EC2 {InstanceId=i-af3544c6}
CPUUtilization AWS/EC2 {InstanceId=i-d4f29ebd}
CPUUtilization AWS/EC2 {ImageId=ami-de4daab7}
...
```
### リクエスト例
次の例では、指定した名前を持つメトリクスを一覧表示します。
```
mon-list-metrics --metric-name RequestCount
```
### リクエスト例
次の例では、指定した名前空間に属するメトリクスを一覧表示します。
```
mon-list-metrics --namespace MyService
```
### リクエスト例
次の例では、指定したディメンション名と値を持つメトリクスを一覧表示します。
```
mon-list-metrics --dimensions "User=SomeUser,Stack=Test"
```
## 関連トピック
### ダウンロード
+ [コマンドラインインターフェイスをセットアップする](SetupCLI.md)
### 関連アクション
+ [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)
### 関連コマンド
+ [mon-describe-alarms](cli-mon-describe-alarms.md)