NiftyGetMetricStatistics
処理概要
RDBサービスのモニタリング情報を取得します。
モニタリング要素について、詳しくは下記ヘルプページをご確認ください。
StartTime、EndTimeの組み合わせによる情報の取得範囲は下記のようになります。
StartTime・EndTimeの補足表
| 要素名 | 説明 |
|---|---|
| 何も指定しない | すべてのモニタリング情報を取得（最大1週間分） |
| StartTimeのみ指定 | StartTime〜現在時刻のイベントを取得 |
| EndTimeのみ指定 | モニタリング情報が存在する最古の時刻〜EndTimeのイベントを取得 |
| StartTimeとEndTimeを指定 | StartTime〜EndTimeのイベントを取得 |
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| Dimensions.member.N.Name | string |
Dimensions.member.N.Valueとセットで要素を指定します。要素は「DBInstanceIdentifier」のみ指定可能です。 |
○ |
| Dimensions.member.N.Value | string |
Dimensions.member.N.NameとセットでDBサーバー名を指定します。 |
○ |
| MetricName | string |
取得対象のデータ名を指定します。 値:
|
○ |
| StartTime | timestamp |
モニタリング情報の読み出し期間の開始時間
|
|
| EndTime | timestamp |
モニタリング情報の読み出し期間の終了時間
|
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| NiftyGetMetricStatisticsResponse | structure |
ルート |
| ␣NiftyGetMetricStatisticsResult | structure |
結果 |
| ␣␣Label | string |
取得対象データ名 |
| ␣␣Datapoints | list |
モニタリング情報リスト |
| ␣␣␣member | structure |
モニタリング情報 |
| ␣␣␣␣NiftyTargetName | string |
取得対象DBサーバー名 |
| ␣␣␣␣Timestamp | timestamp |
モニタリング日時 |
| ␣␣␣␣Sum | double |
モニタリング値 |
| ␣␣␣␣SampleCount | integer |
サンプル数（常に1） |
| ␣ResponseMetadata | structure |
共通メタ情報 |
| ␣␣RequestId | string |
リクエスト識別子 |
エラー
| コード | メッセージ | タイプ | 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を指定しなかった場合 |
| Client.InvalidParameterRequired.DBInstanceIdentifier | The parameter Dimensions.member.1.Value is required. |
Sender | 400 | 必須のDimensions.member.N.Valueを指定しなかった場合 |
| Client.InvalidParameterRequired.DBInstanceIdentifier | 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://jp-east-1.rdb.api.nifcloud.com/
?Action=NiftyGetMetricStatistics
&Dimensions.member.1.Name=DBInstanceIdentifier
&Dimensions.member.1.Value=mydbinstance
&StartTime=2014-12-26 00:00:00
&EndTime=2014-12-27 00:00:00
&SignatureVersion=2
&AccessKeyId
&SignatureMethod=HmacSHA256
&Timestamp=2014-12-26T16:28:09.000Z
&Signature
&MetricName=BinLogDiskUsage
応答サンプル
<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>
