OpenStack API Dokumentation¶
Verwenden Sie das OpenStack API zum Starten von Instanzen, Erzeugen von Abbildern, Zuweisen von Metadaten zu Instanzen und Abbildern, Erzeugen von Storage Containern und Objekten sowie weiteren Aktionen in Ihrer OpenStack Cloud.
Bemerkung
Die Links weiter unten sind gruppiert entsprechend dem API-Status welcher den Status des Endpunktes des Services beschreibt.
‚Current‘ bezeichnet eine stabile Version, die up-to-date ist und ggf. Versionsaktualisierungen erhalten wird. Dieser Endpunkt sollten vor allen anderen bevorzugt werden.
‚Supported‘ ist eine stabile Version, die auf dem Server verfügbar ist. Sie ist aber wahrscheinlich nicht die neueste verfügbare Version und wird vielleicht nicht aktualisiert oder wird in Zukunft als deprecated erklärt.
‚Deprecated‘ ist eine stabile Version, die noch verfügbar aber veraltet ist und eventuell in Zukunft entfernt wird.
‚Experimental‘ ist keine stabile Version. Diese Version ist in Entwicklung oder enthält Eigenschaften die sich noch ändern können.
Weitere Informationen zu den API Status Werten und Versionsinformationen finden Sie unter Version Discovery.
Die Bezeichung ‚(microversions)‘ neben einer API Referenz zeigt an, dass das API einem vom Compute Dienst eingeführten Muster folgt um kleinere, dokumentierte Änderungen an dem API auf einer Ressourcen-Basis zu ermöglichen.
Aktuelle API-Versionen¶
Application Container Service API (microversions)
Bare Metal API v1 (microversions)
Bemerkung
Das Block Storage API v3 ist funktionell identisch mit der Block Storage API v2. Nachfolgende API v3 Mikroversionen, wie z.B. v3.1, unterscheiden sich vom API v2.
Compute API (microversions)
Container Infrastruktur Management API (Microversions)
Data Protection Orchestration v1
Domain Name Server (DNS) API v2
Identität API v3 Erweiterungen
Placement API (Microversions)
Ressourcen-Optimierungs-API v1
Geteilte Dateisysteme API v2 (Microversions)
Bemerkung
Die Shared File Systems API v1 ist funktionell identisch mit der Shared File Systems API v2. Nachfolgende API v2 Mikroversionen, wie z.B. v2.1, unterscheiden sich vom API v1.
Unterstützte API Versionen¶
Veraltete API-Versionen¶
Bemerkung
Das Block Storage API v3 ist funktionell identisch mit der Block Storage API v2. Nachfolgende API v3 Mikroversionen, wie z.B. v3.1, unterscheiden sich vom API v2.
API Schnellstart Beispiele¶
Bei der TryStack OpenStack Installation arbeiten diese Dienste zusammen im Hintergrund und viele der Beispiele funktionieren auf TryStack.
Nach dem Sie sich über Identität authentifiziert haben können Sie die anderen OpenStack APIs verwenden, um Resourcen in Ihrer OpenStack Cloud zu erstellen und zu verwalten. Sie können Instanzen von Images starten und Metadaten, durch die Compute API oder den openstack Kommandozeilenclient, Ihren Instanzen zuweisen.
Um mit dem Senden von API Anfragen zu beginnen, benutzen Sie eine der folgenden Methoden:
cURL
Ein Kommandozeilenwerkzeug, dass Sie HTTP-Anfragen senden lässt und Antworten empfängt. Lesen Sie die Sektion OpenStack APIs.
OpenStack Kommandozeilenclients
Das OpenStack Project bietet einen Kommandozeilen-Client, der Ihnen durch einfach zu verwendende Kommando Zugriff zu APIs gewährt. Lesen Sie OpenStack Kommandozeilenclients.
REST Clients
Sowohl Mozilla wie auch Google bieten browserbasierte grafische Oberflächen für REST. Für Firefox, siehe RESTClient. Für Chrome, siehe rest-client.
OpenStack Python Software Development Kit (SDK)
Benutzen Sie dieses SDK um Python Skripte zu schreiben, welche Resourcen in Ihrer OpenStack Cloud erzeugen und managen. Das SDK implementiert Python Bindings zur OpenStack API, die Ihnen erlauben automatische Tasks in Python auf Python Objekten auszuführen anstelle REST Calls direkt aufzurufen. Alle OpenStack Kommandozeilentools benutzen das Python SDK in ihrer Implementierung. Siehe auch das OpenStack Python SDK in dem OpenStack End User Guide.
