MQL 照会サービス

説明

MQL で記述された照会を使用してモデル・オブジェクト・データを取得するには、このリソースを使用します。 MQL 照会サービスでは、モデル・オブジェクト・クラス・リソースで使用できる情報より詳細な情報を確認できます。

HTTP メソッド

GET

モデル・オブジェクトを照会します。

パラメーター

depth=値

照会の深さ。 デフォルト値は 1 です。

注: 深さが 1 より大きい照会では、大きな結果セットが返され、TADDM サーバーでメモリー不足状態が発生する可能性があります。 この問題を回避するには、fetchSize=1 を指定し、連続照会を使用して、一度に 1 つの位置ずつデータをスクロールします。 この手法を使用する方法の例についは、$COLLATION_HOME/sdk/examples/rest ディレクトリーにあるサンプル・プログラムを参照してください。

フィード= {json|xml}

戻されるデータに使用する形式。 json または xml を指定します。 このパラメーターはオプションです。

feed パラメーターを指定しないと、サーバーは HTTP Accept ヘッダーで指定される形式 (application/json または application/xml) を使用します。 このヘッダーを指定しないと、結果は JSON 形式で戻されます。

fetchSize=値

結果セットから返されるオブジェクトの最大数。 デフォルト値は 1 です。

longClassName= {true|false}

出力におけるすべてのモデル・オブジェクト・クラス名が、完全修飾の形式 (com.collation.platform.model.topology.sys.ComputerSystem など) を使用して指定される必要があるかどうかを指定します。 true または false を指定します。 このオプションは、JSON 出力に対してのみ有効です。 デフォルト値は false です。

mssGuid=値

オブジェクトに関連付けられた管理ソフトウェア・システム (MSS) の GUID 値。 このパラメーターはオプションです。

position=値

照会から返すオブジェクトの、結果セット内の開始位置。 デフォルト値は 1 です (結果セット内の最初のオブジェクト)。 結果セット内のオブジェクトの総数を超える位置を指定した場合、オブジェクトは返されません。

query=値

MQL 表記で記述された、照会ストリング。 このパラメーターは必須です。

注: モデル・オブジェクト照会は、大量のデータを返す可能性があります。 メモリーおよびパフォーマンス上の問題を回避するには、必要な列のみを選択します。

戻り

照会が正常に行われた場合、サーバーは、HTTP 戻りコード 200 と、JSON または XML の形式 (feed パラメーターまたは HTTP Accept ヘッダーで形式指定) の照会結果データを返します。 照会でデータが返されない場合、フィード・タイプに応じて、結果セットは空の JSON 配列または XML 文書になります。

返されたデータの TADDMQueryComplete プラグマ・ヘッダーは、使用可能なすべての照会結果が返されたかどうかを示します。true は、すべての結果が返されたことを示し、false は、使用可能な照会結果がまだあることを示します。 オプションの position および fetchSize パラメーターの値を調整して、返される結果を制御できます。

例

http://example.com:9430/rest/model/MQLQuery?query=select%20displayName,
OSRunning.OSName%20from%20ComputerSystem&position=2&fetchSize=2&feed=xm
l&depth=2&position=4