API-Programmierhandbuch › CA Enterprise Log Manager-API-Beispiele › GetObject

GetObject

Sie können diese Befehlsdatei verwenden, um verschiedene Informationstypen abzurufen. Sie können die Datei verwenden, um eine Liste mit Abfragen, Berichten oder globalen Parametern und die ELM-Schemadefinition (CEG) abzurufen. Der Befehl "getObject" verwendet einen Qualifizierer oder ein Argument namens "type", um festzulegen, welche Daten, wie in nachfolgendem Beispiel, an den Aufrufer zurückgegeben werden:

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

Nachfolgende Liste enthält eine Zusammenfassung der Datentypen, die mit den Varianten dieses Befehls zurückgegeben wurden:

getQueryList

Gibt einen XML-String zurück, der alle Abfragen in CA Enterprise Log Manager anzeigt. "getQueryList" unterstützt viele Filterparameter, mit deren Hilfe Sie geeignete Abfragenamen auswählen und in Ihre API-Aufrufe aufnehmen können.

getReportList

Gibt einen XML-String zurück, der alle Berichte in CA Enterprise Log Manager anzeigt. "getReportList" unterstützt viele Filterparameter, mit deren Hilfe Sie geeignete Berichtsnamen auswählen und in Ihre API-Aufrufe aufnehmen können.

getDataModel

Gibt die ELM-Schemadefinition (CEG) im XML-Format zurück. Sie wählen CEG-Begriffe aus, die Sie in den API-Aufruf-Filter einschließen möchten.

getIdealModel

Gibt die Idealmodelle zurück, die in CEG definiert wurden. Sie wählen Begriffe aus großen Produktbereichen aus, die Sie in den Filter des API-Aufrufs einschließen möchten.

getIncidentModel

Gibt die verfügbaren CEG-Felder zurück, die in von der Ereigniskorrelation generierten Incidents verwendet werden.

getCombinedModel

Gibt die ELM-Schemadefinition (CEG) in XML-Format für die Felder "Ereignis" und "Incident" zurück. Sie wählen CEG-Begriffe aus, die Sie in den API-Aufruf-Filter einschließen möchten.

getGlobalSettings

Gibt die globalen Einstellungen des CA Enterprise Log Manager-Servers zurück, mit denen der Befehl ausgeführt wird. Sie erkennen, welcher Filter bereits für CA Enterprise Log Manager-Abfragen gesetzt sind, so dass Sie effektive API-Aufruf-Filter erstellen können.

getELMServers

Gibt eine Liste mit CA Enterprise Log Manager-Servern zurück. Dieser Befehl ist in einer föderierten Umgebung nützlich, da Sie mit dem Befehl über- oder untergeordnete Server erreichen können, die Sie abfragen möchten.

getTimeZones

Ermittelt eine Liste mit Zeitzonen, die in ausgeführten Abfragen als Argumente verwendet werden können.

getVersion

Gibt die ELM-Version zurück, die mit der Version der APIs identisch und für Diagnosezwecke nützlich ist.

getObjectDefinition

Gibt die Metadaten für einen Bericht oder eine Abfrage mit einer bestimmten Objekt-ID zurück. Zu den Metadaten zählen alle Formatierungsdaten, die festlegen, wie ein Bericht oder eine Abfrage dargestellt wird. Verwenden Sie die Metadaten, wenn Sie die Abfrage "runQuery" verwenden müssen, um CA Enterprise Log Manager-Daten für eine Anwendung zu erfassen, die den Abfrage- oder Berichts-Viewer nicht direkt einbetten kann.

getQueryViewer

Gibt die HTML zurück, die die Komponente des Abfrage-Viewers enthält, die mit einer bestimmten Abfrage vorab geladen wurde.

getReportViewer

Gibt die HTML zurück, die die Komponente des Berichts-Viewers enthält, die mit einem bestimmten Bericht vorab geladen wurde.

Mit Ausnahme von "getQueryViewer" und "getReportViewer" geben alle "GetObject"-Befehle einen Fehler zurück, wenn im API-Befehl keine Authentifizierungssitzung vorhanden ist:

Fehlermeldung:
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> User is not logged in</Description>
</Result>

Im vorherigen Beispiel war der Ergebniswert "false", dies zeigt einen Fehler an, und die Beschreibung enthält den Grund, in diesem Fall: "User is not logged in" (Benutzer ist nicht angemeldet).

Weitere Informationen:

Aufrufe des Abfrage- und Berichts-Viewers