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 verfgbar ist. Sie ist aber wahrscheinlich nicht die neueste verfgbare Version und wird vielleicht nicht aktualisiert oder wird in Zukunft als deprecated erklrt.

  • Deprecated ist eine stabile Version, die noch verfgbar aber veraltet ist und eventuell in Zukunft entfernt wird.

  • Experimental ist keine stabile Version. Diese Version ist in Entwicklung oder enthlt Eigenschaften die sich noch ndern knnen.

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 eingefhrten Muster folgt um kleinere, dokumentierte nderungen an dem API auf einer Ressourcen-Basis zu ermglichen.

Aktuelle API-Versionen

Acceleration API v2

Admin Logik API

Application Catalog API v1

Application Container Service API (microversions)

Backup API v2

Bare Metal API v1 (microversions)

Blockspeicher API v3

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.

Clustering API v1

Compute API (microversions)

Container Infrastruktur Management API (Microversions)

Data Processing v1.1

Data Protection Orchestration v1

Datenbankdienst API v1.0

Domain Name Server (DNS) API v2

EC2 API Service

Function Engine

Identitt API v3

Identitt API v3 Erweiterungen

Abbilddienst API v2

Key Manager API v1

Load Balancer API v2

Nachrichtendienst API v2

Netzwerk API v2.0

NFV Orchestration API v2.0

Objekt Storage API v1

Orchestrierung API v1

Placement API (Microversions)

Ressourcen-Optimierungs-API v1

Suche 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.

Untersttzte API Versionen

NFV Orchestration API v1.0

Veraltete API-Versionen

Block Storage API v2

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.

Identitt API v2.0 Erweiterungen

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 Identitt authentifiziert haben knnen Sie die anderen OpenStack APIs verwenden, um Resourcen in Ihrer OpenStack Cloud zu erstellen und zu verwalten. Sie knnen 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 lsst und Antworten empfngt. 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 gewhrt. Lesen Sie OpenStack Kommandozeilenclients.

  • REST Clients

    Sowohl Mozilla wie auch Google bieten browserbasierte grafische Oberflchen fr REST. Fr Firefox, siehe RESTClient. Fr 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 auszufhren 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.