HP OneView - Handbuch (Seite 65)

5.6 REST-API-Version
Beim Durchführen eines REST-API-Vorgangs ist der Header X-API-Version erforderlich. Dieser
Versionsheader entspricht der REST-API-Version der derzeit auf der Appliance ausgeführten Software.
Um die korrekte REST-API-Version zu bestimmen, führen Sie /rest/version aus. Für diesen
GET
-Vorgang ist kein X-API-Version-Header erforderlich. Wenn in Ihrer Umgebung mehrere
Appliances ausgeführt werden, müssen Sie bestimmen, welche REST-API-Version von jeder Appliance
benötigt wird.
Der Header X-API-Version dieser Veröffentlichung von HP OneView muss immer 3
(X-API-Version:3) sein.
5.7 Asynchrone vs. synchrone Vorgänge
Bei einer synchronen Aufgabe wird nach dem REST-API-Vorgang eine Antwort zurückgegeben. So
gibt POST /rest/server-profiles im Antworttext beispielsweise ein neu erstelltes Serverprofil
zurück. Bei einer asynchronen Aufgabe, wie z. B. Erstellen einer Appliance-Sicherungskopie wird
der URI des Ressourcen-Modells TaskResource zurückgegeben. Sie können mit Hilfe des URI
des Ressourcen-Modells TaskResource den aktuellen Status des Vorgangs zurückgeben.
5.8 Aufgaben-Ressource
Beim Durchführen eines asynchronen REST-API-Vorgangs wird der HTTP-Status 202 Accepted
zurückgegeben. Außerdem wird der URI des Ressourcen-Modells TaskResource im Header
Location
der Antwort zurückgegeben.
Sie können für den URI des Modells TaskResource den Vorgang GET durchführen, um den
Status des asynchronen Vorgangs abzufragen. Das Modell TaskResource enthält zudem den
Namen und den URI der Ressource, auf die sich die Aufgabe im Attribut associatedResource
auswirkt.
Beispiel für das Erstellen einer Appliance-Sicherungskopie
1. Erstellen Sie eine Sicherungskopie der Appliance.
/rest/backups
Im Header Location der Antwort wird der URI einer TaskResource zurückgegeben.
2. Fragen Sie mit dem in Schritt 1 zurückgegebenen TaskResource-URI den Status der Sicherungskopie ab.
/rest/tasks/{id}
3. Wenn die Aufgabe den Status Completed erreicht, laden Sie mittels des associatedResource-URI in
TaskResource
die Sicherungsdatei herunter.
GET {associatedResource URI}
5.9 Fehlerbehandlung
Sollte während eines REST-API-Vorgangs ein Fehler auftreten, wird der Fehler 4xx (clientseitig)
oder 5xx (Appliance) zusammen mit einer Fehlermeldung (ErrorMessage Ressourcen-Modell)
zurückgegeben. Die Fehlermeldung enthält eine Beschreibung und möglicherweise empfohlene
Maßnahmen zur Fehlerkorrektur.
Wenn der REST-API-Vorgang POST erfolgreich ist, wird die neu erstellte Ressource (synchron) oder
ein TaskResource-URI (asynchron) im Header „Location“ (Ort) zurückgegeben.
5.10 Nebenläufigkeitssteuerung über ETags
Ein Client überprüft die Version des Ressourcen-Modells mittels ETags. Dadurch wird verhindert,
dass der Client eine nicht aktuelle Version des Ressourcen-Modells ändert (mit PUT). Angenommen,
ein Client führt den Vorgang GET für ein Serverprofil aus und empfängt im Antwortheader ein
5.6 REST-API-Version 65