本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>API>RDB>NiftyGetMetricStatistics

RDB:NiftyGetMetricStatistics

処理概要

RDBサービスのモニタリング情報を取得します。

モニタリング要素について、詳しくは下記ヘルプページをご確認ください。

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

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

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
Dimensions.member.N.Name Dimensions.member.N.Valueとセットで要素を指定します。要素は「DBInstanceIdentifier」のみ指定可能です。 文字列  
Dimensions.member.N.Value Dimensions.member.N.NameとセットでDBサーバー名を指定します。 文字列  
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取得対象データ名一覧表
要素名 説明
BinLogDiskUsage バイナリログサイズ
CPUUtilization CPU使用率(非アイドル)
DatabaseConnections DBコネクション数
DiskQueueDepth ディスクIOのキュー数
FreeableMemory メモリの空き容量
FreeStorageSpace ディスクの空き容量
ReplicaLag リードレプリカのマスターとの遅延(MySQL エンジンのみ対応)
SwapUsage スワップ領域の使用量
ReadIOPS ディスクの読み込みIOPS
WriteIOPS ディスクの書き込みIOPS
ReadThroughput ディスクの読み込みスループット
WriteThroughput ディスクの書き込みスループット

レスポンス

XML

status

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

result
要素名 説明 備考
NiftyGetMetricStatisticsResponse ルート  
NiftyGetMetricStatisticsResult 結果  
Datapoints モニタリング情報リスト リスト  
member モニタリング情報    
NiftyTargetName 取得対象キュー名 文字列  
Timestamp モニタリング日時 日時  
Sum モニタリング値 数値  
SampleCount サンプル数(常に1) 数値  
Label 取得対象データ名 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
Client.InvalidParameterCombination.MonitoringStartTime.and.MonitoringEndTime The parameter EndTime must be greater than StartTime. Sender 400 EndTimeにStartTimeより前の日時を指定した場合
Client.InvalidParameterFormat.DBInstanceIdentifier Dimensions.member.1.Value is invalid. Sender 400 Dimensions.member.N.Valueに数字から始まる値を指定した場合
Client.InvalidParameterIllegalInput.DBInstanceIdentifier The parameter Dimensions.member.1.Name must be a value in the set [ DBInstanceIdentifier ] Sender 400 Dimensions.member.N.Nameに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MetricName The parameter MetricName must be a value in the set [ BinLogDiskUsage,CPUUtilization,DatabaseConnections,DiskQueueDepth,FreeableMemory,FreeStorageSpace,ReplicaLag,SwapUsage,ReadIOPS,WriteIOPS,ReadThroughput,WriteThroughput ] Sender 400 MetricNameに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MonitoringEndTime EndTime is invalid. Sender 400 EndTimeに無効な値を指定した場合
Client.InvalidParameterIllegalInput.MonitoringStartTime StartTime is invalid. Sender 400 StartTimeに無効な値を指定した場合
Client.InvalidParameterRequired.DBInstanceIdentifier The parameter Dimensions.member.1.Name is required. Sender 400 必須のDimensions.member.N.Nameを指定しなかった場合
The parameter Dimensions.member.1.Value is required. Sender 400 必須のDimensions.member.N.Valueを指定しなかった場合
The parameter Dimensions.member.1.Name or Value is required. Sender 400 Dimensions.member.1.NameとDimensions.member.1.Valueの両方を指定しなかった場合
Client.InvalidParameterRequired.MetricName MetricName is required. Sender 400 必須のMetricNameを指定しなかった場合
Client.InvalidParameterTooLarge.DBInstanceIdentifier Dimensions.member.1.Value can not be greater than 63 characters. Sender 400 Dimensions.member.N.Valueに63文字を超える値を指定した場合
Client.InvalidParameterTooManyItem.DBInstanceIdentifier The collection Dimensions must not have a size greater than 10. Sender 400 Dimensions.memberに11件以上指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=NiftyGetMetricStatistics
    &Dimensions.member.1.Name=DBInstanceIdentifier
    &Dimensions.member.1.Value=mydbinstance
    &StartTime=2014-12-26%2000%3A00%3A00
    &EndTime=2014-12-27%2000%3A00%3A00
    &SignatureVersion=2
    &AccessKeyId=
    &SignatureMethod=HmacSHA256
    &Timestamp=2014-12-26T16%3A28%3A09.000Z
    &Signature=
    &MetricName=BinLogDiskUsage
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<NiftyGetMetricStatisticsResponse>
  <NiftyGetMetricStatisticsResult>
    <Datapoints>
      <member>
        <NiftyTargetName>mydbinstance</NiftyTargetName>
        <Timestamp>2014-12-26T06:03:26Z</Timestamp>
        <Sum>4096.0</Sum>
        <SampleCount>1</SampleCount>
      </member>
      <member>
        <NiftyTargetName>mydbinstance</NiftyTargetName>
        <Timestamp>2014-12-26T06:13:26Z</Timestamp>
        <Sum>4096.0</Sum>
        <SampleCount>1</SampleCount>
      </member>
    </Datapoints>
    <Label>BinLogDiskUsage</Label>
  </NiftyGetMetricStatisticsResult>
  <ResponseMetadata>
    <RequestId>06f8640f-5112-4c0b-a99e-158412abd428</RequestId>
  </ResponseMetadata>
</NiftyGetMetricStatisticsResponse>

推奨画面サイズ 1024×768 以上