HP OneView - Handbuch (Seite 63)

5 Verwenden der REST-APIs und anderer
Programmierungsschnittstellen
REST (Representational State Transfer) ist ein Webdienstformat, das grundlegende CRUD- (Create,
Read, Update and Delete) Vorgänge verwendet, die mittels HTTP, POST, GET, PUT und DELETE
auf Ressourcen durchgeführt werden. Unter
http://en.wikipedia.org/wiki/
Representational_state_transfer erfahren Sie mehr zu REST-Konzepten.
Die Appliance besitzt eine ressourcenbezogene Architektur, die eine einheitliche REST-Schnittstelle
bietet. Jede Ressource besitzt einen URI (Uniform Resource Identifier) und repräsentiert ein physisches
Gerät oder eine logische Konstruktion. Ressourcen können mittels REST-APIs manipuliert werden.
Allgemeine Informationen zu REST-APIs finden Sie unter den folgenden Themen:
•
„Ressourcen-Vorgänge“
•
„Rückgabecodes“
•
„URI-Format“
•
„Format des Ressourcen-Modells“
•
„Anmelden bei der Appliance über REST-APIs“
•
„REST-API-Version“
•
„Asynchrone vs. synchrone Vorgänge“
•
„Aufgaben-Ressource“
•
„Fehlerbehandlung“
•
„Nebenläufigkeitssteuerung über ETags“
•
„Abfragen von Ressourcen über geläufige REST-API-Parameter“
•
„State-Change Message Bus“
•
„Entwicklertools in einem Webbrowser“
•
„Verwenden der Python- und Windows PowerShell-Befehle (technische Vorschau)“
5.1 Ressourcen-Vorgänge
RESTful-APIs sind zustandslos. Der Ressourcen-Manager verwaltet den Ressourcen-Zustand, der als
Ressourcen-Repräsentation gemeldet wird. Der Client verwaltet den Anwendungszustand und
manipuliert die Ressource möglicherweise lokal. Der dem Ressourcen-Manager bekannte Zustand
ändert sich aber erst dann, wenn ein PUT oder POST durchgeführt wird.
Beschreibung HTTP-Verb Vorgang
Erstellt neue Ressourcen. Ein synchroner POST-Vorgang gibt die neu
erstellte Ressource zurück. Ein asynchroner POST-Vorgang gibt im
Header Location einen TaskResource-URI zurück. Dieser URI
verfolgt den Status des POST-Vorgangs. POST resource URI (payload =
resource data)
Create
(Erstellen)
Gibt die angeforderte(n) Repräsentation(en) zurück GET resource URI Read (Lesen)
Aktualisiert eine bestehende Ressource PUT resource URI (payload =
update data)
Update
(Aktualisieren)
Löscht die angegebene Ressource DELETE resource URI Delete
(Löschen)
5.1 Ressourcen-Vorgänge 63