CMDBQueryBuilderAPI - グローバル

CMDBQueryBuilderAPI は、クエリービルダーの保存済みクエリー実行の詳細をサーバー側スクリプトで取得するメソッドを提供します。

この API にアクセスするには、構成管理 (CMDB) (com.snc.cmdb) プラグインをアクティブ化する必要があります。

CMBD クエリビルダーの詳細については、「 CMDB のクエリ」を参照してください。

CMDBQueryBuilderAPI - getSavedQueryExecutionDetails(文字列 savedQueryName, ブール executeQuery, 数値 timeout)

指定された 構成管理データベース (CMDB) クエリービルダー保存済みクエリーの実行の詳細を返します。

必要に応じて、最新のクエリー実行の詳細を返すために、クエリーを実行するかどうかを指定できます。クエリー実行のデフォルトのタイムアウト制限を上書きすることもできます。

クエリー実行中にタイムアウトやメモリーの問題が発生した場合は、クエリーのバッチサイズを微調整すると、これらの問題を軽減できます。詳細については、「クエリ ビルダーの保存済みクエリのバッチサイズ」を参照してください。

表 : 1. パラメーター

名前	タイプ	説明
executeQuery	ブーリアン	オプション。指定されたクエリーを実行するかどうかを示すフラグ。 有効な値： true：指定されたクエリーを実行し、実行の詳細を返します。 false：指定されたクエリーを実行しません。クエリーの最新の実行の詳細を返します。 デフォルト値：False
savedQueryName	文字列	クエリの実行の詳細を返す対象の CMDB クエリビルダー保存済みクエリの名前。
timeout	番号	オプション。デフォルトのクエリー実行タイムアウト制限の 5 分を上書きする整数値。 単位：秒 デフォルト：5 分

表 : 2. 返される内容

タイプ	説明
エラー	エラーコードとメッセージ。クエリー実行が失敗した場合、または指定されたクエリーが見つからない場合に返されます。 エラーの例： {"error": "QUERY_EXECUTION_NOT_FOUND", "message": "Query execution details not found. Please execute the query."} {"error": "QUERY_NOT_FOUND", "message": "Given saved query not found. Please make sure you are passing the name of a saved query."} {"error": "QUERY_EXECUTION_FAILED", "message": "Query execution failed. Please use a valid query."}
query_id	保存済みクエリーの実行 ID (sys_id) です。クエリーステータス [qb_query_status] テーブルから取得されます。
table_name	クエリー実行の詳細を含むテーブルの名前。
status	クエリー実行のステータス。 COMPLETE：実行が完了しました。 FAILED：クエリー実行中にエラーが発生しました。 TIME_OUT：クエリー実行がタイムアウトしました。 MAX_LIMIT：返される結果の最大数に達しました。

この例は、getSavedQueryExecutionDetails() メソッドを呼び出す方法を示しています。

SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true);

出力:

{"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}

この例は、getSavedQueryExecutionDetails() メソッドを呼び出して、デフォルトのクエリー実行タイムアウト値を 10 分に上書きする方法を示しています。

SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true, 600);

出力:

{"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}