Clients der VMware Aria Operations-API implementieren einen REST-Workflow, indem sie HTTP-Anforderungen an den Server senden und den Antworten des Servers die benötigten Informationen entnehmen.
Über REST
REST, ein Akronym für „Representational State Transfer“, beschreibt ein architektonisches Merkmal von Programmen, bei denen das Hypertext Transfer Protocol (HTTP) für den Austausch serialisierter Objektdarstellungen zwischen einem Client und einem Server verwendet wird. In der VMware Aria Operations-API handelt es sich bei diesen Darstellungen um JSON- oder XML-Dokumente.
In einem REST-Workflow werden zwischen einem Client und einem Server Darstellungen von Objekten in der ausdrücklichen Annahme übergeben, dass keine Seite etwas anderes über ein Objekt wissen muss als das, was in einer einzelnen Anforderung oder Antwort dargestellt wird. Die URLs, unter denen diese Dokumente verfügbar sind, haben oft länger Bestand als die Anforderung oder die Antwort, in der sie enthalten sind.
REST API – Workflows
Zur Verwendung einer REST API erstellte Anwendungsprogramme verwenden HTTP-Anforderungen, die häufig von einem Skript oder einer anderen Sprache auf höherer Ebene ausgeführt werden, um aus der Ferne Prozesse zum Erstellen, Abrufen, Aktualisieren oder Löschen von der API festgelegter Objekte aufzurufen. In der REST API von VMware Aria Operations werden diese Objekte durch eine Sammlung von XML-Schemata definiert. Bei den Vorgängen selbst handelt es sich um HTTP-Anforderungen. Sie sind daher für alle HTTP-Clients generisch.
Um eine Client-Anwendung für eine REST API zu schreiben, müssen Sie nur das HTTP-Protokoll und die Semantik von JSON bzw. XML (dem Übertragungsformat, das die VMware Aria Operations-API verwendet) kennen. Um die API in einem solchen Client effektiv einzusetzen, müssen Sie sich mit den folgenden Konzepten vertraut machen.
- Dem Satz von Objekten, den die API unterstützt, und dem, was diese Objekte darstellen.
- Wie die API diese Objekte darstellt.
- Wie ein Client sich auf ein Objekt bezieht, mit dem ein Vorgang ausgeführt werden soll.
Die API-Referenz enthält eine vollständige Auflistung der API-Anforderungen. Weitere Informationen hierzu finden Sie unter Zugreifen auf die Swagger-Dokumentation für Schemareferenz.