Greifen Sie über die API auf die Berichtsdatenbank zu
Mit der leistungsstarken API von Cloud Insights können Benutzer die Cloud Insights Reporting-Datenbank direkt abfragen, ohne über die Cognos Reporting-Umgebung zu gehen.
|
Diese Dokumentation bezieht sich auf die Cloud Insights-Berichtsfunktion, die in der Cloud Insights Premium Edition verfügbar ist. |
Odata
Die Cloud Insights-Reporting-API folgt der "OData v4" (Open Data Protocol)-Standard für die Abfrage der Reporting-Datenbank. Weitere Informationen finden Sie unter "Dieses Lernprogramm" Zu OData.
Alle Anfragen beginnen mit der url https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata
APIKey wird generiert
Weitere Informationen "Cloud Insights APIs".
Gehen Sie zum Generieren eines API-Schlüssels wie folgt vor:
-
Melden Sie sich in Ihrer Cloud Insights-Umgebung an und wählen Sie Admin > API-Zugriff.
-
Klicken Sie auf „+ API Access Token“.
-
Geben Sie einen Namen und eine Beschreibung ein.
-
Wählen Sie für Typ Data Warehouse.
-
Legen Sie Berechtigungen als Lese-/Schreibzugriff fest.
-
Legen Sie ein Ablaufdatum für „Wünsche“ fest.
-
Klicken Sie auf „Speichern“, dann kopieren Sie den Schlüssel und speichern Sie ihn* irgendwo sicher. Sie können später nicht auf den vollständigen Schlüssel zugreifen.
APIkeys sind gut für Sync oder Async.
Direkte Abfrage von Tabellen
Mit dem vorhandenen API-Schlüssel sind nun direkte Abfragen der Reporting-Datenbank möglich. Lange URLs können für Anzeigezwecke auf https://…/odata/ vereinfacht werden und nicht für die volle https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/
Versuchen Sie einfache Abfragen wie
-
https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/dwh_Custom
-
https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/dwh_Inventory
-
https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/dwh_Inventory/Storage
-
https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/dwh_Inventory/Disk
-
https://…/odata/dwh_custom/custom_queries
Beispiele FÜR REST-API
Die URL für alle Anrufe lautet https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata.
-
GET /{Schema}/** - ruft Daten aus der Berichtsdatenbank ab.
Format: https://<Cloud Insights URL>/Rest/v1/dwh-Management/odata/<Schema_Name>/<query>
Beispiel:
https://<domain>/rest/v1/dwh-management/odata/dwh_inventory/fabric?$count=true&$orderby=name Ergebnis:
{ "@odata.context": "$metadata#fabric", "@odata.count": 2, "value": [ { "id": 851, "identifier": "10:00:50:EB:1A:40:3B:44", "wwn": "10:00:50:EB:1A:40:3B:44", "name": "10:00:50:EB:1A:40:3B:44", "vsanEnabled": "0", "vsanId": null, "zoningEnabled": "0", "url": "https://<domain>/web/#/assets/fabrics/941716" }, { "id": 852, "identifier": "10:00:50:EB:1A:40:44:0C", "wwn": "10:00:50:EB:1A:40:44:0C", "name": "10:00:50:EB:1A:40:44:0C", "vsanEnabled": "0", "vsanId": null, "zoningEnabled": "0", "url": "https://<domain>/web/#/assets/fabrics/941836" } ] }
Hilfreiche Tipps
Beachten Sie bei der Arbeit mit Reporting API-Abfragen Folgendes:
-
Die Zuladung der Abfrage muss ein gültiger JSON-String sein
-
Die Zuladung der Abfrage muss in einer einzigen Zeile enthalten sein
-
Doppelte Anführungszeichen müssen entfloh werden, d. h. \“
-
Registerkarten werden als \t unterstützt
-
Kommentare vermeiden
-
Tabellennamen mit niedrigerer Groß-/Kleinschreibung werden unterstützt
Zusätzlich:
-
2 Kopfzeilen sind erforderlich:
-
Name „X-CloudInsights-ApiKey“
-
Attributwert „<apikey>“
-
Der API-Schlüssel ist spezifisch für Ihre Cloud Insights-Umgebung.
Synchron oder asynchron?
Standardmäßig wird ein API-Befehl im synchronen-Modus ausgeführt, d. h., Sie senden die Anforderung und die Antwort wird sofort zurückgegeben. Manchmal kann die Ausführung einer Abfrage jedoch lange dauern, was zu einer Zeitüberschreitung der Anfrage führen kann. Um dies zu umgehen, können Sie eine Anfrage asynchron ausführen. Im asynchronen Modus gibt die Anforderung eine URL zurück, über die die Ausführung überwacht werden kann. Die URL gibt das Ergebnis zurück, wenn sie fertig ist.
Um eine Abfrage im asynchronen Modus auszuführen, fügen Sie den Header hinzu Prefer: respond-async
Auf die Anfrage. Nach erfolgreicher Ausführung enthält die Antwort die folgenden Kopfzeilen:
Status Code: 202 (which means ACCEPTED) preference-applied: respond-async location: https://<Cloud Insights URL>/rest/v1/dwh-management/odata/dwh_custom/asyncStatus/<token>
Wenn Sie die URL für den Speicherort abfragen, werden die gleichen Header zurückgegeben, wenn die Antwort noch nicht bereit ist, oder wenn die Antwort bereit ist, wird sie mit dem Status 200 zurückgegeben. Der Antwortinhalt ist vom Typ Text und enthält den http-Status der ursprünglichen Abfrage sowie einige Metadaten, gefolgt von den Ergebnissen der ursprünglichen Abfrage.
HTTP/1.1 200 OK OData-Version: 4.0 Content-Type: application/json;odata.metadata=minimal oDataResponseSizeCounted: true { <JSON_RESPONSE> }
Um eine Liste aller asynchronen Abfragen zu sehen und welche davon bereit sind, verwenden Sie den folgenden Befehl:
GET https://<Cloud Insights URL>/rest/v1/dwh-management/odata/dwh_custom/asyncList Die Antwort hat das folgende Format:
{ "queries" : [ { "Query": "https://<Cloud Insights URL>/rest/v1/dwh-management/odata/dwh_custom/heavy_left_join3?$count=true", "Location": "https://<Cloud Insights URL>/rest/v1/dwh-management/odata/dwh_custom/asyncStatus/<token>", "Finished": false } ] }