APIs Explorer verwenden

Auf dieser Seite wird erläutert, wie Sie mit dem APIs Explorer die Dataproc Metastore API-Methoden testen. APIs 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 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 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

  1. 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.
  2. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  3. Dataproc Metastore API aktivieren.

    Aktivieren Sie die API

  4. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  5. Dataproc Metastore API aktivieren.

    Aktivieren Sie die API

Zugriff auf den APIs Explorer

Der APIs 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.

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

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. Unter Tipps finden Sie einige Hinweise zum Beheben von Fehlern.

Zusätzliche Parameter angeben

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

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.

Verwenden Sie Felder, um die Ausgabe weiter einzuschränken.

Standardmäßig entspricht der von APIs Explorer angezeigte Satz von Parametern den Parametern der zugehörigen Methode. Das APIs 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 APIs Explorer-Feld sehr nützlich, in dem die Ausgabe in einem Feld angezeigt wird. Es gibt oft eine Menge zu scrollen.

Tipps

Die folgenden Abschnitte enthalten Tipps für APIs Explorer.

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

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

Probleme mit den Werten

Bei der Verwendung der APIs 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 herum.
  • 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 fällt Ihnen dort das Problem auf.
  • 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 APIs 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.

Authentifizierung

Auf der Seite API Explorer“ befindet sich über der Schaltfläche Ausführen der Abschnitt Anmeldedaten. Normalerweise sind hier keine Änderungen erforderlich.

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.

Weitere Informationen