CMDBQueryBuilderAPI – Global

Die CMDBQueryBuilderAPI stellt Methoden zum Abrufen der im Abfragegenerator gespeicherten Abfrageausführungsdetails in serverseitigen Skripts bereit.

Um auf diese API zuzugreifen, müssen Sie das Plugin „Configuration Management (CMDB)“ (com.snc.cmdb) aktivieren.

Weitere Informationen zum CMBD-Abfragegenerator finden Sie unter CMDBabfragen.

CMDBQueryBuilderAPI – getSavedQueryExecutionDetails(String gespeichertQueryName, Boolean executeQuery, Number timeout)

Gibt die Ausführungsdetails für eine angegebene gespeicherte Abfrage des Configuration Management Database (CMDB) Abfragegenerators zurück.

Optional können Sie angeben, ob die Abfrage ausgeführt werden soll, um die Details der letzten Abfrageausführung zurückzugeben. Sie können auch die standardmäßige Zeitüberschreitung für die Ausführung der Abfrage überschreiben.

Im Falle einer Zeitüberschreitung oder eines Speicherproblems beim Ausführen der Abfrage können Sie die Batch-Größe der Abfrage optimieren, um diese Probleme zu beheben. Weitere Informationen finden Sie unter Batch-Größe für gespeicherte Abfragen des Abfragegenerators.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
executeQuery	Boolean	Optional. Kennzeichnung, die angibt, ob die angegebene Abfrage ausgeführt werden soll oder nicht. Gültige Werte: true: Führt die angegebene Abfrage aus und gibt ihre Ausführungsdetails zurück. false: Die angegebene Abfrage wird nicht ausgeführt. Gibt die letzten Ausführungsdetails der Abfrage zurück. Standardwert: False
gespeicherterAbfragename	Zeichenfolge	Name der gespeicherten CMDB-Abfragegeneratorabfrage, für die Abfrageausführungsdetails zurückgegeben werden sollen.
Zeitüberschreitung	Nummer	Optional. Ganzzahliger Wert, der die standardmäßige Zeitüberschreitungsgrenze der Abfrageausführung von fünf Minuten überschreibt. Einheit: Sekunden Standard: Fünf Minuten

Tabelle : 2. Ergebnisse

Typ	Beschreibung
Fehler	Fehlercode und Meldung. Wird zurückgegeben, wenn die Ausführung der Abfrage fehlschlägt oder die angegebene Abfrage nicht gefunden wird. Fehlerbeispiele: {"error": "QUERY_EXECUTION_NOT_FOUND", "message": "Details zur Abfrageausführung nicht gefunden. Führen Sie die Abfrage aus.“} {"error": "QUERY_NOT_FOUND", "message": "Angegebene gespeicherte Abfrage nicht gefunden. Stellen Sie sicher, dass Sie den Namen einer gespeicherten Abfrage übergeben.“} {"error": "QUERY_EXECUTION_FAILED", "message": "Abfrageausführung fehlgeschlagen. Verwenden Sie eine gültige Abfrage.}
query_id	Ausführungs-ID der gespeicherten Abfrage (sys_id). Abgerufen aus der Tabelle „Abfragestatus“ [qb_query_status].
table_name	Name der Tabelle, die die Ausführungsabfragedetails enthält.
status	Status der Abfrageausführung. COMPLETE: Die Ausführung ist abgeschlossen. FAILED: Fehler beim Ausführen der Abfrage. TIME_OUT: Zeitüberschreitung bei Abfrageausführung. MAX_LIMIT: Maximale Anzahl der zurückgegebenen Ergebnisse erreicht.

Dieses Beispiel zeigt, wie die Methode getSavedQueryExecutionDetails() aufgerufen wird.

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

Ausgabe:

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

Dieses Beispiel zeigt, wie die Methode getSavedQueryExecutionDetails() aufgerufen und der Standardwert für die Zeitüberschreitung der Abfrageausführung auf 10 Minuten überschrieben wird.

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

Ausgabe:

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