Voraussetzungen

In diesem Dokument werden die Voraussetzungen für die Verwendung der Compute Engine API erläutert.

Bevor Sie mit der Codierung Ihrer ersten Client-Anwendung beginnen können, sind noch einige Vorbereitungen zu treffen, falls noch nicht geschehen.

Erstellen Sie sich ein Google-Konto

Sie benötigen ein Google-Konto, um auf die Compute Engine API zuzugreifen. Wenn Sie bereits ein Konto haben, haben Sie bereits Zugriff.

Für Testzwecke könnte ein separates Google-Konto sinnvoll sein.

Compute Engine registrieren und verwenden

Sie können mithilfe der folgenden Anleitungen eine VM-Instanz in der Compute Engine erstellen:

Bevor Sie fortfahren, sollten Sie sich mit der Compute Engine vertraut machen. In der API-Dokumentation wird davon ausgegangen, dass Sie Compute Engine bereits verwendet haben und mit Webprogrammierkonzepten und Webdatenformaten vertraut sind.

Weitere Informationen zur Authentifizierung

Je nachdem, wie Sie auf die API zugreifen, gibt es verschiedene Möglichkeiten, sich bei der Compute Engine zu authentifizieren. Weitere Informationen finden Sie unter Bei der Compute Engine authentifizieren.

Informationen über REST

Es gibt zwei Möglichkeiten, die API aufzurufen:

Wenn Sie sich gegen die Verwendung von Clientbibliotheken entscheiden, müssen Sie die Grundlagen von REST verstehen.

Grundlagen von REST

REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.

Der Begriff REST steht für Representational State Transfer. Im Zusammenhang mit Google-APIs bezieht es sich auf die Verwendung von HTTP-Verben zum Abrufen und Ändern von Darstellungen von Daten, die von Google gespeichert sind.

In einem als "RESTful" bezeichneten System werden Ressourcen in einem Datenspeicher abgelegt; ein Client sendet eine Aufforderung, der Server möge eine bestimmte Aktion ausführen (z. B. eine Ressource erstellen, abfragen, aktualisieren oder löschen), und der Server führt die Aktion aus und sendet eine Antwort, oft in Form einer Darstellung der angegebenen Ressource.

In Googles RESTful APIs spezifiziert der Client eine Aktion mit einem HTTP-Verb wie POST, GET, PUT oder DELETE. Eine Ressource wird anhand eines weltweit eindeutigen URIs im folgenden Format spezifiziert:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.

Dafür können die Methodendefinitionen in der Dokumentation der HTTP 1.1-Standards hilfreich sein. Hier finden Sie auch die Spezifikationen für GET, POST, PUT und DELETE.

REST in der Compute Engine API

Die Vorgänge der Compute Engine API sind REST-HTTP-Verben direkt zugeordnet.

Die Compute Engine API verwendet das folgende Format für URIs:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH

Der URI enthält die folgenden Werte:

  • API_VERSION: Die API-Version, die Sie verwenden möchten. Sie entspricht der Einführungsphase einer Compute Engine-Ressource:
    • Für Ressourcen in GA: v1
    • Für Ressourcen in der öffentlichen Vorschau: beta
    • Für Ressourcen in der privaten Vorschau: alpha
  • RESOURCE_PATH: der Pfad zur bestimmten Compute Engine-Ressource, z. B. projects/example-project/aggregated/instances. Informationen zu den verfügbaren Ressourcen für jede API-Version finden Sie unter den folgenden Links:

Wenn Sie Abfrageparameter einfügen möchten, fügen Sie sie nach einem Fragezeichen (?) in den URI ein:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS

Im URI ist QUERY_PARAMETERS eine Liste von Abfrageparametern, die durch kaufmännische Und-Zeichen (&) getrennt sind, z. B. format=json&filter=zone=us-central1-a.

Informationen über das JSON-Datenformat

Die Compute Engine API gibt Daten im JSON-Format zurück.

JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.