クラウドAPI（専有エンドポイント：GetMetricStatistics）

専有エンドポイントサービスのモニタリング情報を取得します。

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

StartTime・EndTimeの補足表

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

要素名	説明	必須	値	最大値	デフォルト値	備考
Dimensions.member.N.Name	Dimensions.member.N.Valueとセットで要素を指定します。 例：&Dimensions.member.1.Name=DEPInstanceIdentifier&Dimensions.member.1.Value =testDEPInstance 要素は「DEPInstanceIdentifier」のみ指定可能です。	○	文字列	-	-	Nの部分は連番
Dimensions.member.N.Value	Dimensions.member.N.Nameとセットで専有エンドポイント名を指定します。 ※1〜63字のアルファベット・数字・ハイフン('-')が使用できます ※最初の文字はアルファベットである必要があります ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません	○	文字列	-	-	Nの部分は連番
MetricName	取得対象のデータ名を指定します。 指定可能なデータ名は下記「MetricName取得対象データ名一覧表」をご覧ください。	○	文字列	-	-
StartTime	モニタリング情報の（yyyy-mm-dd hh24:mi）の範囲開始日時 yyyy-mm、yyyy-mm-dd、yyyy-mm-dd hh24といった指定も可能です。		日付	-	-
EndTime	モニタリング情報の（yyyy-mm-dd hh24:mi）の範囲終了日時 yyyy-mm、yyyy-mm-dd、yyyy-mm-dd hh24といった指定も可能です。		日付	-	-

MetricName取得対象データ名一覧表

要素名	説明
ActiveConnections	アクティブなコネクション数
ReadTraffic	読み込みデータ流量（Bytes/s）
WriteTraffic	書き込みデータ流量（Bytes/s）

XML

status

statusは共通の応答メッセージを返却します。

result

要素名	説明	値	備考
GetMetricStatisticsResponse	ルート	−
GetMetricStatisticsResult	結果	−
Datapoints	モニタリング情報リスト	−
member	モニタリング情報	−
TargetName	取得対象キュー名	文字列
Timestamp	モニタリング日時	日付
Sum	モニタリング値	数値
SampleCount	単位時間あたりのサンプル数	数値
Label	取得対象データ名	文字列
ResponseMetadata	共通メタ	−

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameterCombination.MonitoringStartTime.and.MonitoringEndTime	The parameter EndTime must be greater than StartTime.	Sender	400	GetMetircStatisticsの取得期間が開始日時より終了日時が早い時間だった場合
Client.InvalidParameterFormat.DEPInstanceIdentifier	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.InvalidParameterIllegalInput.DEPInstanceIdentifier	The parameter Dimensions.member.N.Name must be a value in the set [ DEPInstanceIdentifier ].	Sender	400	Dimensions.member.N.Nameに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MetricName	The parameter MetricName must be a value in the set [ ActiveConnections,ReadTraffic,WriteTraffic ].	Sender	400	MetricNameに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MonitoringEndTime	Invalid value 2014/01/01 for EndTime.	Sender	400	EndTimeに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MonitoringStartTime	Invalid value 2014/01/01 for StartTime.	Sender	400	StartTimeに無効な値を指定した場合
Client.InvalidParameterRequired.DEPInstanceIdentifier	The parameter Dimensions.member.N.Name is required.	Sender	400	必須のDimensions.member.N.Nameを指定しなかった場合
Client.InvalidParameterRequired.DEPInstanceIdentifier	The parameter Dimensions.member.N.Value is required.	Sender	400	必須のDimensions.member.N.Valueを指定しなかった場合
Client.InvalidParameterRequired.MetricName	The parameter MetricName must be provided and must not be blank.	Sender	400	必須のMetricNameを指定しなかった場合
Client.InvalidParameterTooLong.DEPInstanceIdentifier	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文字を超える値を入力した場合
Client.InvalidParameterTooManyItem.DEPInstanceIdentifier	The collection Dimensions must not have a size greater than 10.	Sender	400	Dimensions.memberに11件以上指定した場合

https://jp-east-1.dep.api.nifcloud.com/
    ?Action=GetMetricStatistics
    &Dimensions.member.1.Name=DEPInstanceIdentifier
    &Dimensions.member.1.Value=example-dep-server
    &MetricName=ActiveConnections
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2017-11-15T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>

<GetMetricStatisticsResponse>
  <GetMetricStatisticsResult>
    <Datapoints>
      <member>
        <TargetName>example-dep-server</TargetName>
        <Timestamp>2017-11-15T20:07:17.000+09:00</Timestamp>
        <Sum>1.0</Sum>
        <SampleCount>1</SampleCount>
      </member>
      <member>
        <TargetName>example-dep-server</TargetName>
        <Timestamp>2017-11-15T20:08:17.000+09:00</Timestamp>
        <Sum>1.0</Sum>
        <SampleCount>1</SampleCount>
      </member>
      <member>
        <TargetName>example-dep-server</TargetName>
        <Timestamp>2017-11-15T20:09:17.000+09:00</Timestamp>
        <Sum>1.0</Sum>
        <SampleCount>1</SampleCount>
      </member>
    </Datapoints>
    <Label>ActiveConnections</Label>
  </GetMetricStatisticsResult>
  <ResponseMetadata>
  <RequestId>23650cbe-35ec-47ee-8e67-74254b406e20</RequestId>
  </ResponseMetadata>
</GetMetricStatisticsResponse>