Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
CollectorExtendedApp サービス
CollectorExtendedApp サービス
発行日;2012/02/02 | 英語版ドキュメント(2011/07/18 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

CollectorExtendedApp サービス

CollectorExtendedApp サービスについて

getCollectedStatisticalData

getCollectedStatisticalDataByDaysMaxLimit

getCollectedStatisticalDataByMaxLimit

getCollectedStatisticalDataByTimeRange

getCollectedStatisticalDataByTimeRangeInterval

getCollectedStatisticalDataByTimeRangeMaxLimit

getCollectedStatisticalDataSizeByTimeRangeInterval

getPreviousCollectedData

CollectorExtendedApp サービス

この章では、DCNM Web サービスの、CollectorExtendedApp サービスに対応する API メソッドについて説明します。

CollectorExtendedApp サービスについて

コレクタを使用すると、ネットワーク リソースのパフォーマンス管理に対処できます。コレクタで統計データを分析することにより、トラフィック スループット、使用率、エラー率、および応答時間を含む、データのリアルタイム モニタリングを実行できます。その結果、ネットワーク リソースを効率的に使用し、ネットワークの健全性に関する詳細な知識を得ることができます。

コレクタは、デバイスから統計情報を読み取り、データベースに格納できます。コレクタ API を使用し、データベースに保存されている情報を取得できます。さらに、拡張されたコレクタ API を使用して、ある期間にわたって統計データを傾向分析できます。

getCollectedStatisticalData

既存のコレクション情報の収集済み統計データをすべて戻します。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

戻り値

指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションを戻します。

getCollectedStatisticalDataByDaysMaxLimit

日で指定された期間中に既存のコレクション情報の収集済み統計データのリストを戻します。特定の最大制限で結果をフィルタリングします。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

Integer:収集済み統計データを取得する日数を指定します。

maxLimits:戻す最大ポイントを指定します。

戻り値

最大ポイント内の特定の日数から現在の日付の間に指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションのリストを戻します。

getCollectedStatisticalDataByMaxLimit

既存のコレクション情報の収集済み統計データのリストを戻し、最大制限の結果をフィルタリングします。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

maxLimits:戻す最大ポイントを指定します。

戻り値

最大ポイント内の指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションのリストを戻します。

getCollectedStatisticalDataByTimeRange

開始時刻と終了時刻で指定された期間中に既存のコレクション情報の収集済み統計データをすべて戻します。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

startTime:収集済み統計データを取得する時間範囲の開始を指定します。

endTime:収集済み統計データを取得する時間範囲の終了を指定します。

戻り値

指定された時間範囲中に指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションを戻します。

getCollectedStatisticalDataByTimeRangeInterval

開始時刻と終了時刻で指定された期間中に既存のコレクション情報の収集済み統計データをすべて戻します。特定の間隔で結果をフィルタリングします。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

startTime:収集済み統計データを取得する時間範囲の開始を指定します。

endTime:収集済み統計データを取得する時間範囲の終了を指定します。

intervalInSeconds:間隔をフィルタリングする必要があることを指定します。

戻り値

指定された時間範囲と期間中に指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションを戻します。

getCollectedStatisticalDataByTimeRangeMaxLimit

開始時刻と終了時刻で指定された期間中に既存のコレクション情報の収集済み統計データをすべて戻します。特定の最大制限で結果をフィルタリングします。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

startTime:収集済み統計データを取得する時間範囲の開始を指定します。

endTime:収集済み統計データを取得する時間範囲の終了を指定します。

maxLimits:戻す最大ポイントを指定します。

戻り値

最大ポイント内の開始時刻と終了時刻で指定された期間中に指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションのリストを戻します。

getCollectedStatisticalDataSizeByTimeRangeInterval

開始時刻と終了時刻で指定された期間中に既存のコレクション情報の収集済み統計データのサイズを戻します。特定の間隔で結果をフィルタリングします。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

startTime:収集済み統計データを取得する時間範囲の開始を指定します。

endTime:収集済み統計データを取得する時間範囲の終了を指定します。

intervalInSeconds:間隔をフィルタリングする必要があることを指定します。

戻り値

指定された時間範囲と期間中に指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションのサイズを戻します。

getPreviousCollectedData

既存のコレクション情報の最後にポーリングされた統計データよりも前のものを戻します。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

戻り値

最後にポーリングされたデータよりも前の統計データである CollectedData のインスタンスを戻します。