API Explorer verwenden

Auf dieser Seite wird beschrieben, wie Sie mit dem API Explorer die Methoden von Dataproc Metastore testen. API Explorer ist ein Widget, das an die 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 zeigt ein Formular mit den Parametern für jede Methode an. Füllen Sie das Formular aus, klicken Sie auf die Schaltfläche Ausführen und sehen Sie sich die Ergebnisse an.

Sie können das Widget auch ausblenden, indem Sie am oberen Rand auf die Schaltfläche „Schließen“ klicken. Sie können das Widget auch im Vollbildmodus öffnen, indem Sie auf die Schaltfläche „Vollbild“ klicken.

Hinweis

Zugriff auf den API Explorer

Der API Explorer ist an die Referenzseite für jede REST API-Methode angehängt. Das Widget finden Sie auf der Referenzseite für eine Methode, z. B. die 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 sind mit einem roten Balken markiert, bis sie ausgefüllt sind. Sie können eine minimale Anfrage ausführen, indem Sie nur die erforderlichen Argumente angeben.

Mit der Methode services.create wird ein Dataproc Metastore-Dienst in einem ausgewählten Projekt und einem ausgewählten Standort erstellt. Die Pflichtfelder sind die Felder parent und serviceId. Geben Sie zum Erstellen eines Dienstes die Projektnummer und Standort-ID Ihres Projekts für parent im Format projects/{projectNumber}/locations/{locationId} an. Geben Sie die Dienst-ID für serviceId an.

Jetzt testen

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

Wenn der Header rot ist und einen HTTP-Fehlercode enthält, enthält das Feld die Fehlermeldung. Unter Tipps finden Sie Hinweise zum Beheben von Fehlern.

Zusätzliche Parameter angeben

Die Liste der angezeigten Parameter hängt von der Methode ab, an die das API Explorer-Widget angehängt ist. Die Methode services.create enthält nicht nur die Parameter parent und serviceId, aber sie sind die einzigen Pflichtparameter.

Mit dem optionalen Parameter requestId können Sie eine eindeutige Anfrage-ID angeben, sodass 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-Feld sehr nützlich, in dem die Ausgabe in einem Feld angezeigt wird. Es gibt oft eine Menge zu scrollen.

Tipps

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

Ersetzen Sie {projectNumber} and {locationId} durch die Nummer und die Standort-ID Ihres Projekts. Beachten Sie, dass die API anstelle der Nummer auch die Projekt-ID akzeptiert.

Probleme mit den Werten

Bei der Verwendung der API Explorer-Formulare sollten Sie auf Folgendes achten: Diese Fehler können Fehler verursachen oder akzeptiert werden, werden aber wie Rechtschreibfehler in der API-Methode behandelt:

  • Verwenden Sie keine Anführungszeichen um Feldwerte.
  • 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-Codierung. 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 fällt Ihnen das Problem auf.
  • Sie können einen Wert für das Feld pageSize angeben, z. B. 2. Dadurch wird die Datenmenge begrenzt, die beim Debuggen des API-Aufrufs zurückgegeben wird.

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

Authentication

Auf der Seite „API Explorer“ befindet sich oberhalb der Schaltfläche Ausführen der Abschnitt Anmeldedaten. In der Regel müssen Sie hier nichts ändern.

Der Standardauthentifizierungsmechanismus ist Google OAuth 2.0.

Im Bereich Anmeldedaten gibt es außerdem die Option Bereiche anzeigen. Hier sehen Sie, welche Compute Engine-Bereiche verfügbar sind. Standardmäßig sind alle verfügbaren Bereiche aktiviert.

Nächste Schritte