API Explorer verwenden

Auf dieser Seite wird erläutert, wie Sie mit dem Dataproc Explorer API-Methoden der Dataproc Metastore testen. API Explorer ist ein Widget, das auf der REST API-Referenzseite für eine Methode angehängt ist. Es wird als Steuerfeld mit dem Titel API testen angezeigt.

Der API Explorer ist eine hervorragende Möglichkeit, Methoden in der Dataproc Metastore API auszuprobieren, ohne Code schreiben zu müssen. Das Widget enthält ein Formular mit den Parametern für jede Methode. Füllen Sie das Formular aus, klicken Sie auf Ausführen und sehen Sie sich die Ergebnisse an.

Sie können das Widget auch ausblenden, indem Sie oben im Steuerfeld auf die Schaltfläche closeSchließen“ klicken. Wenn Sie es in den Vollbildmodus erweitern möchten, klicken Sie auf die Schaltfläche für den Vollbildmodus.

Hinweis

  • Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.
  • Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  • Aktivieren Sie die Dataproc Metastore API.

    Aktivieren Sie die API

Zugriff auf den API Explorer

Der API Explorer ist für jede REST API-Methode an die Referenzseite angehängt. Das Widget finden Sie auf der Referenzseite für eine Methode, z. B. auf der Referenzseite für Dataproc Metastore projects.locations.services.create.

Eine minimale Anfrage ausführen

Die meisten Methoden haben einige erforderliche und einige optionale Parameter. Die erforderlichen Cluster werden mit einem roten Balken gekennzeichnet, bis sie ausgefüllt sind. Sie können eine minimale Anfrage ausführen, indem Sie nur die erforderlichen Argumente angeben.

Die Methode services.create erstellt einen Dataproc Metastore-Dienst in einem ausgewählten Projekt und an einem ausgewählten Standort. Die Pflichtfelder sind die Felder parent und serviceId. Wenn Sie einen Dienst erstellen möchten, geben Sie die Projektnummer und die Standort-ID Ihres Projekts für parent mithilfe des Formulars projects/{projectNumber}/locations/{locationId} an. Geben Sie außerdem die Dienst-ID für serviceId an.

Jetzt testen

Die Ergebnisse des Methodenaufrufs werden in einem Feld unter der Schaltfläche Ausführen angezeigt. Normalerweise enthält das Feld einen grünen Header mit dem HTTP-Statuscode 200, was bedeutet, dass die Anfrage erfolgreich war.

Wenn der Header rot ist und einen HTTP-Fehlercode enthält, enthält das Feld die Fehlermeldung. Tipps zur Behebung von Fehlern finden Sie unter Tipps.

Zusätzliche Parameter angeben

Die Liste der Parameter hängt von der Methode ab, mit der das API Explorer-Widget verknüpft ist. Die Methode services.create enthält mehr als nur die Parameter parent und serviceId, aber die einzigen sind die erforderlichen Parameter.

Sie können den optionalen requestId-Parameter verwenden, um eine eindeutige Anfrage-ID anzugeben, damit der Server die Anfrage ignorieren kann, wenn sie abgeschlossen ist.

Felder verwenden, um die Ausgabe weiter einzuschränken

Standardmäßig entspricht der von API Explorer angezeigte Satz von Parametern den Parametern der zugehörigen Methode. Das API Explorer-Widget verfügt jedoch auch über eine Reihe zusätzlicher Felder, die nicht über die Methode selbst verfügbar sind.

Diese Parameter sind unter dem Schalter Standardparameter anzeigen ausgeblendet.

Klicken Sie auf diesen Schalter, um die zusätzlichen Widget-Parameter anzuzeigen. Klicken Sie auf Standardparameter ausblenden, um sie aus der Ansicht auszublenden.

Der nützlichste dieser Standardparameter ist der Parameter Felder, mit dem Sie die Felder in der zurückgegebenen Ausgabe auswählen können, die Sie sehen möchten. Dies ist im API Explorer sehr nützlich, da die Ausgabe dort in einem Feld angezeigt wird. Es gibt oft eine Menge zu scrollen.

Tipps

Die folgenden Abschnitte enthalten Tipps zu API Explorer.

Denken Sie daran, {projectNumber} and {locationId} zu ändern.

Denken Sie daran, {projectNumber} and {locationId} durch die Nummer und die Standort-ID Ihres Projekts zu ersetzen. Die API akzeptiert auch die Projekt-ID anstelle der Nummer.

Probleme mit den Werten

Bei der Verwendung von API Explorer-Formularen sollten Sie folgende Punkte beachten. Diese Fehler können Fehler verursachen oder werden akzeptiert, aber wie Rechtschreibfehler in der API-Methode behandelt:

  • Setzen Sie Feldwerte jedes Typs in Anführungszeichen.
  • Achten Sie darauf, Strings in Filtern anzugeben. Verwenden Sie doppelte Anführungszeichen (") und keine Apostrophe (').
  • Verwenden Sie in Formularfeldern keine umgekehrten Schrägstriche oder URL-Codierungen. Bei Bedarf wird die URL-Codierung für die Feldwerte durchgeführt, wenn Sie die Methode ausführen.
  • Sehen Sie sich den Wert im Ergebnisfeld an, nachdem Sie den Aufruf ausgeführt haben. Möglicherweise bemerken Sie das Problem dort.
  • Geben Sie einen Wert für das Feld pageSize an, z. B. 2. Dadurch wird die Datenmenge begrenzt, die zurückgegeben wird, wenn Sie den API-Aufruf debuggen.

Lesezeichen-URLs für die Fehlerbehebung speichern

Nachdem Sie die gewünschte Ausgabe erhalten haben, speichern Sie die API Explorer-URL als Lesezeichen. Wenn Sie die Methode noch einmal ausführen möchten, fügen Sie die URL in Ihren Browser ein. Das Formular ist bereits mit Ihren Werten ausgefüllt. Nehmen Sie die erforderlichen Änderungen an den Parametern vor und klicken Sie auf Ausführen, um die Methode noch einmal auszuführen.

Authentifizierung

Auf der Seite APIAPI Explorer“ befindet sich über der Schaltfläche Ausführen der Abschnitt Anmeldedaten. Sie müssen hier normalerweise nichts ändern.

Der Standardauthentifizierungsmechanismus ist Google OAuth 2.0.

Im Bereich Anmeldedaten gibt es auch die Ein-/Aus-Schaltfläche Bereiche anzeigen. Dies zeigt Ihnen die verfügbaren Compute Engine-Bereiche. Standardmäßig sind alle verfügbaren Bereiche aktiviert.

Nächste Schritte