ニフクラAPI (NAS: GetMetricStatistics)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>NAS> API> GetMetricStatistics

GetMetricStatistics

処理概要

NASサービスのモニタリング情報を取得します。
モニタリング要素について、詳しくは下記ヘルプページをご確認ください。

ヘルプ：NAS：モニタリング

StartTime、EndTimeの組み合わせによる情報の取得範囲は下記のようになります。

StartTime・EndTimeの補足表

要素名	説明
何も指定しない	すべてのモニタリング情報を取得（最大1週間分）
StartTimeのみ指定	StartTime〜現在時刻のイベントを取得
EndTimeのみ指定	モニタリング情報が存在する最古の時刻〜EndTimeのイベントを取得
StartTimeとEndTimeを指定	StartTime〜EndTimeのイベントを取得

指定するパラメーター

パラメーター	型	説明	必須
Dimensions.member.N.Name	string	Dimensions.member.N.Valueとセットで要素を指定します。要素は「NASInstanceIdentifier」のみ指定可能です。	○
Dimensions.member.N.Value	string	Dimensions.member.N.NameとセットでNAS名を指定します。	○
MetricName	string	取得対象のデータ名を指定します。値: FreeStorageSpace (ディスクの空き容量) UsedStorageSpace (ディスクの使用量) ReadIOPS (ディスクの読み込みIOPS) WriteIOPS (ディスクの書き込みIOPS) ReadThroughput (ディスクの読み込みスループット) WriteThroughput (ディスクの書き込みスループット) ActiveConnections (アクティブなコネクション数) GlobalReadTraffic (グローバルの読み込みデータ流量) PrivateReadTraffic (プライベートの読み込みデータ流量) GlobalWriteTraffic (グローバルの書き込みデータ流量) PrivateWriteTraffic (プライベートの書き込みデータ流量)	○
StartTime	timestamp	モニタリング情報の読み出し期間の開始時間例：2009-07-08 18:00 形式：yyyy-mm-dd hh24:mi
EndTime	timestamp	モニタリング情報の読み出し期間の終了時間例：2009-07-08 18:00 形式：yyyy-mm-dd hh24:mi

応答フィールド

フィールド (項目)	型	説明
GetMetricStatisticsResponse	structure	ルート
␣GetMetricStatisticsResult	structure	結果
␣␣Datapoints	list	モニタリング情報リスト
␣␣␣member	structure	モニタリング情報
␣␣␣␣TargetName	string	取得対象NAS名
␣␣␣␣Timestamp	timestamp	モニタリング日時
␣␣␣␣Sum	double	モニタリング値
␣␣␣␣SampleCount	integer	サンプル数（常に1）
␣␣Label	string	取得対象データ名
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameter.Required.Dimensions.member.Name	The parameter Dimensions.member.N.Name is required	Sender	400	必須のDimensions.member.N.Nameを指定しなかった場合
Client.InvalidParameter.Required.Dimensions.member.Value	The parameter Dimensions.member.N.Value is required	Sender	400	必須のDimensions.member.N.Valueを指定しなかった場合
Client.InvalidParameter.Required.MetricName	The parameter MetricName must be provided and must not be blank.	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:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>