4.5.18　jp1TrendDataService.getLabelList

各マネージャーのトレンドデータ管理DBから，パラメーターで指定した条件に一致するラベルセットの時系列の一覧を取得するメソッドです。

メソッド名

Object jp1TrendDataService.getLabelList(String host, String[] match, String starttime, String endtime, String jp1User)

パラメーター

host

JP1/IM - Managerホストのホスト名を，1〜255バイトの範囲で指定します。

match

トレンドデータ管理DBから取得するラベルセットの絞り込み条件を指定します。

複数の条件を配列で指定でき，指定した場合はOR条件となります。条件は3つまで指定できます。

条件にはメトリック名を指定できます。また，｛｝で囲んだコンマ区切りのリストを追加して，ラベルと「'」で囲んだラベル値の比較条件を，条件に指定できます。比較条件の演算子と指定例を次に示します。

（指定例）

各種ExporterのIM管理ノードを作成する場合

upメトリックのラベルセットを取得するときは，upを指定します。
Yet another cloudwatch exporterのIM管理ノードを作成する場合

__name__ラベルでaws_から始まるラベルセットを取得するときは，{__name__=~'aws_.*'}を指定します。
FluentdのIM管理ノードを作成する場合

fluentd_logtrap_runningメトリックのラベルセットを取得するときは，fluentd_logtrap_runningを指定します。

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秒以前の時刻（マイナス値）は指定できません。

jp1User

次のJP1権限レベルが設定されたJP1ユーザー名を，1〜31バイトの範囲で指定します。

戻り値

ラベルセットの一覧の取得に成功した場合は，ラベルセットの一覧が返却されます。ラベルセットの一覧の形式については，「7.2.3(2) ラベルセットリストオブジェクト」を参照してください。

ラベルセットの一覧の取得に失敗した場合に，オブジェクトに格納されるキーと値を，次に示します。

キー	値
`errorMessage`	エラーメッセージです。トレンドデータ管理サービスのポート番号の取得に失敗した場合は，KAJY62004-Eのメッセージが設定されます。トレンドデータ管理サービスとの通信に失敗した場合は，KAJY62000-Eのメッセージが設定されます。トレンドデータ管理サービスからエラーが返却された場合はKAJY62005-Eのメッセージが設定されます。指定したホストのインテリジェント統合管理基盤への接続に失敗した場合は，KAJY00027-Eのメッセージが設定されます。指定したホストのインテリジェント統合管理基盤の処理で失敗した場合は，KAJY00029-Eのメッセージが設定されます。
`errorMessageId`	エラーメッセージのidを返却します。

キー

値

errorMessage

エラーメッセージです。

errorMessageId

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

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

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

例外

なし