Verwenden Sie den Connector REST API, um in Ihrer Anwendungsumgebung Verbindungen zu REST-konformen
Turbonomic-Services herzustellen.
Es werden nur die REST-APIs users, groups und entities unterstützt.
Vorbereitende Schritte
Wichtig: Der REST-API-Connector wird nur auf Konnektivität zu den REST-APIs users,
groups und entities überprüft. Der Connector wird mit einem begrenzten Zugriff auf Turbonomic-Daten
geprüft. Das in diesem Thema bereitgestellte Umsetzungsscript gilt nur für die genannten APIs und wurde für andere Turbonomic-APIs nicht
verifiziert. Wenden Sie sich an Ihren Ansprechpartner bei IBM Professional Services, um die Unterstützung für andere
Turbonomic-APIs zu aktivieren.
- Stellen Sie sicher, dass Sie die Anwendung 'Turbonomic' auf einem Server in Ihrer Anwendungsumgebung installiert
haben.
Weitere Informationen finden Sie in der Veröffentlichung Turbonomic
Installation Guide.
- Stellen Sie sicher, dass der Turbonomic-Service, zu dem Sie eine Verbindung herstellen wollen,
betriebsbereit ist.
- Sie können Daten nur für die REST-APIs
users, groups und
entities abrufen. Weitere Informationen zu den URI-Formaten finden Sie in der Veröffentlichung
Turbonomic API Guide.
- Erstellen Sie eine Umsetzungsscriptdatei. Die Scriptdatei enthält die Logik, die
die JSON-Antwort in ein kompatibles Format umsetzt, das im Dashboard angezeigt werden kann.
Verwenden Sie
die folgende Beispieldatei, um eine neue Scriptdatei für die Antwortumsetzung zu erstellen:
- Beispielscriptdatei: restapi_sample_response_t12n.txt
- Beispieldateiposition:
$installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n
Dabei ist installationsverzeichnis das Verzeichnis, in dem die Anwendung
installiert wurde. Wenn Sie bei der Installation kein anderes Installationsverzeichnis angegeben
haben, befindet sich die Anwendung standardmäßig im Ordner /opt/icabi.
Die
von Ihnen erstellte Antwortumsetzungsdatei muss die Namenserweiterung .js aufweisen
und muss sich an der gleichen Speicherposition wie die Beispieldatei befinden. Der Dateiname
darf nicht länger als 100 Zeichen sein. Sie müssen den Namen dieser Antwortumsetzungsdatei
im Feld Name des Scripts für die Antwortumwandlung eingeben, wie in den
Prozedurschritten im weiteren Verlauf dieses Abschnitts beschrieben.
- Stellen Sie sicher, dass Sie für eine auf Cookies basierende Authentifizierung ein
JSESSION-Cookie erstellt haben. Das
JSESSION-Cookie verfällt nach einigen Minuten. Daher können Sie das Cookie manuell in einer Datenbanktabelle speichern
und ein Script ausführen, um das Cookie zu aktualisieren. Anschließend können Sie auf das aktualisierte Cookie zugreifen, indem Sie einen
unabhängigen Filter erstellen. Der Filter und ein Script stellen bei jedem Ablauf der Sitzung ein aktualisiertes Cookie bereit. Wenden Sie
sich wegen des Scripts an Ihren Ansprechpartner bei IBM Professional Services.
- Wenn Sie für die Beispielanforderung angepasste Header bereitstellen müssen, müssen Sie sicherstellen, dass
Ihnen diese Informationen zur Verfügung stehen. Angepasste Header sind Anforderungsheader, die zum Abrufen von REST-API-Informationen von
einem Web-Service benötigt werden, wie beispielsweise Anforderungsheader für die Autorisierung oder
Anforderungsheader 'Accept-Charset'. Anforderungsheader für die Autorisierung enthalten
Berechtigungsinformationen, die für den Web-Service erforderlich sind. 'Accept-Charset'
gibt die zulässigen Datenzeichen an, die in der Antwort enthalten sein müssen.
Vorgehensweise
Umsetzungsscriptdatei erstellen.
- Führen Sie die folgenden Schritte aus, um eine Umsetzungsscriptdatei zu erstellen:
- Wechseln Sie in das folgende Verzeichnis, in dem sich die
Beispielscriptdatei restapi_sample_response_t12n.txt für die
Umsetzung befindet:
$installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n
- Erstellen Sie eine Kopie dieser Datei, benennen Sie die Datei um und öffnen
Sie diese Datei in einem beliebigen Texteditor.
- Löschen Sie den Inhalt der Datei, kopieren Sie das folgende Script und
fügen Sie es in die Datei ein:
var input;
var finalJson;
var output;
var outArr=[]
// Parse the input in JSON format
input = JSON.parse(transformationInput)
if(input instanceof Array)
{
outArr= input;
}
else
{
outArr.push(input);
}
finalJson=outArr;
output = JSON.stringify(finalJson);
- Speichern Sie die Datei als JavaScript-Datei mit der Dateierweiterung .js.
Die Scriptdatei für die Umsetzung wurde erstellt.
JSESSION-Cookie generieren
- Führen Sie die folgenden Schritte aus, um ein
JSESSION-Cookie zu generieren:
- Verwenden Sie PuTTY, um sich bei der VM anzumelden, auf der Turbonomic installiert ist.
- Führen Sie den folgenden Befehl aus, um ein
JSESSION-Cookie zu generieren. Die Cookiedatei wird an der
Position generiert, an der Sie den Befehl ausführen.
curl -k -v 'https://server_IP_or_HOSTNAME/vmturbo/rest/login' --data
'username=<user_name>&password=<password>'
Dabei gilt Folgendes:
- server-IP_oder_hostname ist die IP-Adresse oder der Hostname des Servers, auf dem der Turbonomic-Web-Service gehostet
wird.
- <user_name> ist der Benutzername des Administratorkontos.
- <password> ist das Kennwort für das Administratorkonto.
- Führen Sie den folgenden Befehl aus, um den Cookiespeicher anzuzeigen:
cat /<directory_name>/cookies
Im Folgenden sehen Sie ein Beispiel für die Ausgabe, die angezeigt wird:
# Netscape HTTP Cookie File
# http://curl.haxx.se/docs/http-cookies.html
# This file was generated by libcurl! Edit at your own risk.
#HttpOnly_server_IP_or_HOSTNAME FALSE / TRUE 0 JSESSIONID node0orh922baxbyyj4lrgd0nv5pl38.node0
Das JSESSION-Cookie wird als
node0orh922baxbyyj4lrgd0nv5pl38.node0
angezeigt.
Dieses Cookie verfällt nach wenigen Minuten; daher müssen Sie das Cookie erneut erstellen und dies in alle Quellen und Datendefinitionen
eingeben. Wenden Sie sich an Ihren Ansprechpartner bei IBM Professional Services, um diese sich wiederholenden Schritte zu vermeiden.
REST-konforme Turbonomic-Web-Services mithilfe des Connectors REST API hinzufügen
- Führen Sie die folgenden Schritte aus, um REST-konforme Turbonomic-Web-Services mithilfe des Connectors
REST API hinzuzufügen:
- Öffnen Sie Dashboard Designer.
- Rufen Sie im Navigationsbereich auf.
- Klicken Sie auf der Seite 'Alle Connectorquellen' auf Quelle hinzufügen.
Das Fenster Connectorquelle hinzufügen wird angezeigt.
- Wählen Sie in der Liste Connectortyp den Connector REST-API
aus.
- Geben Sie in das Feld Name der Connectorquelle einen Namen für die Quelle ein.
Der Quellenname kann alphanumerische Zeichen und Unterstreichungszeichen enthalten.
- Geben Sie in das Feld Endpunkt-URL die URL-Details für den Web-Service in einem
der folgenden Formate ein:
http://server-IP_oder_hostname/vmturbo/rest/
Dabei gilt Folgendes:
- server-IP_oder_hostname ist die IP-Adresse oder der Hostname des Servers,
auf dem der Web-Service gehostet wird.
- Wählen Sie in der Liste Authentifizierungstyp die Option
Keiner aus.
- Geben Sie den Namen der Umsetzungsscriptdatei im Feld Name des
Scripts für die Antwortumwandlung ein, wenn Sie die Antwort umsetzen wollen.
- Klicken Sie auf Weiter.
- Wählen Sie in der Liste Methode eine Methode aus und führen Sie
basierend auf der ausgewählten Methode einen der folgenden Schritte aus:
- Geben Sie für die Methode GET im Feld URI den URI
(Uniform Resource Identifier) für die Quelle ein.
- Geben Sie für die Methode POST im Feld URI den URI
für die Quelle ein und im Feld Anforderungshauptteil die POST-Anforderung.
Beispiel-URI für die Methode GET: users
- Geben Sie unter Angepasste Header den folgenden Header und den folgenden Wert ein:
- Klicken Sie auf Verbindung testen, um sicherzustellen, dass die
Verbindung zur Datenquelle erfolgreich war.
Wenn die Quellendetails und die Beispielanforderung gültig und vollständig sind, wird eine
Nachricht angezeigt, die besagt, dass die Verbindung erfolgreich hergestellt wurde. Wird eine
Nachricht ausgegeben, die besagt, dass ein Verbindungsfehler aufgetreten ist, müssen Sie die in der
Nachricht beschriebenen Fehler beheben und die Verbindung erneut testen.
Anmerkung: Auch wenn die Quellendetails gültig sind, kann es vorkommen, dass eine
Verbindungsfehlernachricht angezeigt wird. Dies ist der Fall, wenn für die Beispielanforderung eine
ungültige Antwort empfangen wird.
- Klicken Sie auf Speichern.
Ergebnisse
Auf der Seite
Alle Connectorquellen werden die folgenden Details für jede Connectorquelle angezeigt:
- Name der Connectorquelle
- Connectortyp
- Datum und Uhrzeit der erstmaligen Erstellung der Connectorquelle sowie der Benutzername des Benutzers, der die Quelle anfänglich erstellt hat.
- Datum und Uhrzeit der letzten Änderung der Connectorquelle sowie der Benutzername des Benutzers, der die Connectorquelle zuletzt geändert hat. Es wird nur der neueste Datensatz angezeigt.
Der REST-API-Service wird hinzugefügt und kann verwendet werden, um angepasste Datendefinitionen zu erstellen.