Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス


4.5.17 jp1TrendDataService.getTrendData

トレンドデータ管理DBからトレンドデータ(時系列データ)を取得するメソッドです。jp1TrendDataService.getTrendDataメソッドの詳細を次に示します。

メソッド名

Object jp1TrendDataService.getTrendData(String jp1user, String sid, String promQLQuery, String starttime, String endtime, String step)

パラメーター
jp1user

JP1ユーザー名を1〜31バイトの範囲で指定します。

引数sidで指定するSIDに,引数jp1userで指定したJP1ユーザーに参照権限がないSIDを指定した場合,0件のデータを返却します。

注※ JP1ユーザーに設定されているJP1資源グループのうち,次のどれかのJP1権限レベルを持つJP1資源グループが,引数sidに指定したSIDに設定されていない場合が該当します。

  • JP1_Console_Admin

  • JP1_Console_Operator

  • JP1_Console_User

sid

構成情報のSIDを指定します。

引数promQLQueryで指定するPromQL文内に,置き換え文字列「$jp1im_TrendData_labels」が含まれる場合,引数sidで指定した構成情報のSIDに設定されているjp1im_TrendData_labelsの値に置き換えてトレンドデータ管理サービスに渡します。

promQLQuery

トレンドデータの絞り込み条件をPromQL文で指定します。

指定できるPromQL文については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「2.7.4(4)PromQLについて」を参照してください。

starttime

トレンドデータを取得する開始時刻を,UTC 1970年1月1日00:00:00(UNIXエポック)からの経過秒数で指定します。1970年1月1日午前0時0分0秒以前の時刻(マイナス値)は指定できません。

endtime

トレンドデータを取得する終了時刻を,UTC 1970年1月1日00:00:00(UNIXエポック)からの経過秒数で指定します。1970年1月1日午前0時0分0秒以前の時刻(マイナス値)は指定できません。

step

トレンドデータの取得間隔を秒数で指定します。

戻り値

トレンドデータの取得に成功した場合は,トレンドデータの情報を格納したトレンドデータオブジェクトが返却されます。トレンドデータオブジェクトの形式については,「7.2.3(1) トレンドデータオブジェクト」を参照してください。

トレンドデータの取得に失敗した場合に,オブジェクトに格納されるキーと値を,次に示します。

キー

errorMessage

エラーメッセージです。

  • 引数jp1userが不正な場合は,KAJY22043-Eのメッセージが設定されます。

  • 引数sidが不正な場合は,KAJY62003-Eのエラーメッセージが設定されます。

  • トレンドデータ管理サービスのポート番号の取得に失敗した場合は,KAJY62004-Eのメッセージが設定されます。

  • トレンドデータ管理サービスとの通信に失敗した場合は,KAJY62000-Eのメッセージが設定されます。

  • トレンドデータ管理サービスからエラーが返却された場合はKAJY62002-Eのメッセージが設定されます。

  • 下位マネージャーで管理する構成情報のSIDを指定し,下位マネージャーのインテリジェント統合管理基盤への接続に失敗した場合は,KAJY00027-Eのメッセージが設定されます。

  • 下位マネージャーで管理する構成情報のSIDを指定し,下位マネージャーのインテリジェント統合管理基盤の処理でエラーが発生した場合は,KAJY00029-Eのメッセージが設定されます。

errorMessageId

エラーメッセージのidを返却します。

このメソッドを呼び出すユーザー作成プラグインのメソッドは,キー「errorMessageId」の値の有無でエラーを判定し,値の内容に応じて,プラグインの仕様に基づいたエラーメッセージやエラー処理を検討してください。

キー「errorMessage」の値は,プラグインの内部ログに出力し,プラグインの障害調査に活用してください。

例外

なし