前のトピック: API の例について

次のトピック: getQueryList

GetObject

このコマンド ファイルを使用すると、さまざまなタイプの情報を取得することができます。 クエリ、レポート、またはグローバル パラメータの一覧および共通イベント文法(CEG)を取得できます。 getObject コマンドは、以下の例のように、「type」という名の修飾子、つまり引数を使用して、ユーザにどのデータを返すかを指定します。

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=type&tag=tagname1&tag=tagnamen&taglogic=OR|AND

このコマンドのバリエーションを使用して返されるデータのタイプの概要を以下に示します。

getQueryList

CA Enterprise Log Manager 内のクエリをすべて表示する XML 文字列を返します。 getQueryList は、多くのフィルタリング パラメータをサポートします。フィルタリング パラメータにより、ユーザは適切なクエリ名を選択して自身の API コールに含めることができます。

getReportList

CA Enterprise Log Manager 内のレポートをすべて表示する XML 文字列を返します。 getReportList は、多くのフィルタリング パラメータをサポートします。フィルタリング パラメータにより、ユーザは適切なレポート名を選択して自身の API コールに含めることができます。

getDataModel

共通イベント文法(CEG)を XML 形式で返します。 ユーザが API コール フィルタリングに含める CEG 条件を選択します。

getIdealModel

CEG で定義された理想モデルを返します。 API コール フィルタリングに含める広範な製品領域条件を選択してください。

getIncidentModel

イベント相関によって生成されたインシデントで使用される利用可能な CEG フィールドを返します。

getCombinedModel

イベントとインシデントの両方のフィールドの 共通イベント文法(CEG)を XML 形式で返します。 ユーザが API コール フィルタリングに含める CEG 条件を選択します。

getGlobalSettings

コマンドの実行対象である CA Enterprise Log Manager サーバのグローバル設定を返します。 CA Enterprise Log Manager クエリに対してどのようなフィルタリングが設定済みであるかを把握できるため、効果的な API コール フィルタを作成できます。

getELMServers

CA Enterprise Log Manager サーバの一覧を返します。 このコマンドでは、クエリの対象とする親または子のサーバをターゲットとすることができるため、フェデレーション環境に便利です。

getTimeZones

実行中のクエリ内の引数として使用できるタイム ゾーンの一覧を取得します。

getVersion

ELM バージョンを返します。API のバージョンと同じです。診断の目的に役立ちます。

getObjectDefinition

特定のオブジェクト ID を付与されたレポートまたはクエリのメタデータを返します。 メタデータとは、レポートまたはクエリがどのように表示されるかを制御するすべての形式設定データです。 クエリまたはレポートのビューアを直接埋め込むことができないアプリケーション用の CA Enterprise Log Manager データを取得するために runQuery コールを使用する必要がある場合には、メタデータを使用します。

getQueryViewer

指定されたクエリがプレロードされたクエリ ビューア コンポーネントを含む HTML を返します。

getReportViewer

指定されたレポートがプレロードされたレポート ビューア コンポーネントを含む HTML を返します。

getQueryViewer と getReportViewer を除くすべての GetObject コマンドでは、API コマンド内に認証されたセッションがない場合、エラーが返されます。

失敗したレスポンスの例: 
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> User is not logged in</Description>
</Result>

上記の例で、結果値は「false」となっており、これは失敗したことを示します。また <Description> タグ内には理由が記述されており、この場合「User is not logged in」となっています。

詳細情報:

クエリ ビューアおよびレポート ビューアのコール