NAS：GetMetricStatistics
処理概要
NASサービスのモニタリング情報を取得します。
モニタリング要素について、詳しくは下記ヘルプページをご確認ください。
StartTime、EndTimeの組み合わせによる情報の取得範囲は下記のようになります。
StartTime・EndTimeの補足表
| 要素名 | 説明 |
|---|---|
| 何も指定しない | すべてのモニタリング情報を取得（最大1週間分） |
| StartTimeのみ指定 | StartTime〜現在時刻のイベントを取得 |
| EndTimeのみ指定 | モニタリング情報が存在する最古の時刻〜EndTimeのイベントを取得 |
| StartTimeとEndTimeを指定 | StartTime〜EndTimeのイベントを取得 |
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| Dimensions.member.N.Name | Dimensions.member.N.Valueとセットで要素を指定します。 要素は「NASInstanceIdentifier」のみ指定可能です。 |
○ | 文字列 | − | − | |
| Dimensions.member.N.Value | Dimensions.member.N.NameとセットでNAS名を指定します。 | ○ | 文字列 | − | − | |
| MetricName | 取得対象のデータ名を指定します。 指定可能なデータ名は下記「MetricName取得対象データ名一覧表」をご覧ください。 |
○ | 文字列 | − | − | |
| StartTime | モニタリング情報の読み出し期間の開始時間 例：2009-07-08 18:00 形式：yyyy-mm-dd hh24:mi |
日付 | − | − | ||
| EndTime | モニタリング情報の読み出し期間の終了時間 例：2009-07-08 18:00 形式：yyyy-mm-dd hh24:mi |
日付 | − | − |
MetricName取得対象データ名一覧表
| 要素名 | 説明 |
|---|---|
| FreeStorageSpace | ディスクの空き容量 |
| UsedStorageSpace | ディスクの使用量 |
| ReadIOPS | ディスクの読み込みIOPS |
| WriteIOPS | ディスクの書き込みIOPS |
| ReadThroughput | ディスクの読み込みスループット |
| WriteThroughput | ディスクの書き込みスループット |
| ActiveConnections | アクティブなコネクション数 |
| GlobalReadTraffic | グローバルの読み込みデータ流量 |
| PrivateReadTraffic | プライベートの読み込みデータ流量 |
| GlobalWriteTraffic | グローバルの書き込みデータ流量 |
| PrivateWriteTraffic | プライベートの書き込みデータ流量 |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| GetMetricStatisticsResponse | ルート | − | |
| GetMetricStatisticsResult | 結果 | − | |
| Datapoints | モニタリング情報リスト | − | |
| member | モニタリング情報 | − | |
| TargetName | 取得対象キュー名 | 文字列 | |
| Timestamp | モニタリング日時 | 日時 | |
| Sum | モニタリング値 | 数値 | |
| SampleCount | サンプル数（常に1） | 数値 | |
| Label | 取得対象データ名 | 文字列 | |
| ResponseMetadata | 共通メタ情報 | − |
エラー
| コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
|---|---|---|---|---|
| Client.InvalidParameter.Reqiured.Dimensions.member.Name | The parameter Dimensions.member.N.Name is required | Sender | 400 | 必須のDimensions.member.N.Nameを指定しなかった場合 |
| Client.InvalidParameter.Reqiured.Dimensions.member.Value | The parameter Dimensions.member.N.Value is required | Sender | 400 | 必須のDimensions.member.N.Valueを指定しなかった場合 |
| Client.InvalidParameter.Reqiured.MetricName | The parameter MetricName is required | Sender | 400 | 必須のMetricNameを指定しなかった場合 |
| Client.InvalidParameter.TooMany.Dimensions.member | The collection Dimensions must not have a size greater than 10. | Sender | 400 | Dimensions.memberに11件以上指定した場合 |
| Client.InvalidParameter.CannotSpecify.Dimensions.member.Name | The parameter Dimensions.member.N.Name must be a value in the set [ NASInstanceIdentifier ]. | Sender | 400 | Dimensions.member.N.Nameに無効な値を指定した場合 |
| Client.InvalidParameter.CannotSpecify.MetricName | The parameter MetricName must be a value in the set [ FreeStorageSpace,ReadIOPS,WriteIOPS,ReadThroughput,WriteThroughput,ActiveConnections,GlobalReadTraffic,PrivateReadTraffic,GlobalWriteTraffic,PrivateWriteTraffic ]. | Sender | 400 | MetricNameに無効な値を指定した場合 |
| Client.InvalidParameter.CannotSpecify.StartTime | Invalid value 2014/01/01 for StartTime. | Sender | 400 | StartTimeに無効な値を指定した場合 |
| Client.InvalidParameter.CannotSpecify.EndTime | Invalid value 2014/01/01 for EndTime. | Sender | 400 | EndTimeに無効な値を指定した場合 |
| Client.InvalidParameter.CannotSpecify.TargetTime | The parameter EndTime must be greater than StartTime. | Sender | 400 | GetMetircStatisticsの取得期間が開始日時より終了日時が早い時間だった場合 |
| Client.InvalidParameter.Format.Dimensions.member.Value | The parameter Dimensions.member.N.Value is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. | Sender | 400 | Dimensions.member.N.Valueに数字から始まる値を指定した場合 |
| Client.InvalidParameter.TooLong.Dimensions.member.Value | The parameter Dimensions.member.N.Value is not a valid identifier because it is longer than 63 characters. | Sender | 400 | Dimensions.member.N.Valueに63文字以上指定した場合 |
リクエストサンプル
https://jp-east-1.nas.api.nifcloud.com/
?Action=GetMetricStatistics
&Dimensions.member.1.Name=NASInstanceIdentifier
&Dimensions.member.1.Value=example-nas-server
&MetricName=FreeStorageSpace
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2016-02-24T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<GetMetricStatisticsResponse>
<GetMetricStatisticsResult>
<Datapoints>
<member>
<TargetName>example-nas-server</TargetName>
<Timestamp>2016-02-02T09:34:22Z</Timestamp>
<Sum>1002993983488.0</Sum>
<SampleCount>1</SampleCount>
</member>
<member>
<TargetName>example-nas-server</TargetName>
<Timestamp>2016-02-02T09:35:22Z</Timestamp>
<Sum>1002993983488.0</Sum>
<SampleCount>1</SampleCount>
</member>
<member>
<TargetName>example-nas-server</TargetName>
<Timestamp>2016-02-02T09:36:22Z</Timestamp>
<Sum>1002993983488.0</Sum>
<SampleCount>1</SampleCount>
</member>
<member>
<TargetName>example-nas-server</TargetName>
<Timestamp>2016-02-02T09:37:22Z</Timestamp>
<Sum>1002993983488.0</Sum>
<SampleCount>1</SampleCount>
</member>
</Datapoints>
<Label>FreeStorageSpace</Label>
</GetMetricStatisticsResult>
<ResponseMetadata>
<RequestId>f22f7e78-4c17-4d1b-96f4-3aa8f145eacb</RequestId>
</ResponseMetadata>
</GetMetricStatisticsResponse>
