API Explorer verwenden

In dieser Anleitung wird beschrieben, wie Sie mit API Explorer Methoden der Monitoring API 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 folgende Screenshot zeigt das Steuerfeld wie für eine Methode mit nur einem Parameter, Name, angezeigt wird:

Das API Explorer-Widget.

Der API Explorer ist eine hervorragende Möglichkeit, Methoden in der Monitoring 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 oben im Steuerfeld auf die Schaltfläche klicken, oder es durch Klicken auf die Schaltfläche in den Vollbildmodus erweitern.

Probieren Sie die Schaltflächen aus!

In der Dokumentation finden Sie Schaltflächen zum Ausprobieren! wie die folgenden Beispiele:

Jetzt testen

Wenn Sie auf die Schaltfläche klicken, wird der API Explorer auf der entsprechenden Referenzseite geöffnet und die Felder entsprechend dem Beispiel ausgefüllt. Sie müssen einige der Felder bearbeiten, damit sie Ihrem eigenen Projekt entsprechen, wie z. B. der Wert für [PROJECT_ID].

Weitere Informationen zum Vermeiden und Beheben von Fehlern finden Sie unter Tipps.

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. auf der Referenzseite für monitoring.projects.metricDescriptors.list.

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.

Die Methode metricDescriptors.list gibt Deskriptoren für alle verfügbaren Messwerttypen in einem Projekt zurück. Das einzige erforderliche Feld ist das Feld Name. Um diese Liste für Ihr Projekt abzurufen, geben Sie den Namen Ihres Projekts als Namen mithilfe des Formulars projects/[PROJECT_ID] an.

Klicken Sie auf die Schaltfläche unten, um es auszuprobieren. Bevor Sie jedoch im Formular auf die Schaltfläche Ausführen klicken, müssen Sie [PROJECT_ID] in die ID Ihres Projekts ändern:

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. Die Ergebnisse des Aufrufs befinden sich im Feld:

Das Ergebnis eines erfolgreichen Methodenaufrufs.

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 API Explorer-Widget angehängt ist. Die Methode metricDescriptors.list hat mehr als nur den Parameter Name, aber Name ist der einzige erforderliche Parameter.

Wenn Sie nur den Projektnamen angeben, erhalten Sie alle Messwertdeskriptoren, die in Ihrem Projekt verfügbar sind, und es gibt viele. Mit dem optionalen Parameter Filter können Sie den Abruf auf einen kleineren Satz beschränken.

Füllen Sie beispielsweise die folgenden Felder auf der Seite metricsDescriptor.list aus. Ersetzen Sie [PROJECT_ID] durch Ihre Projekt-ID, geben Sie jedoch den anderen Wert wie gezeigt an:

  • Name: projects/[PROJECT_ID]
  • Filter: metric.type=ends_with("utilization")

Bei der Ausführung dieser Anfrage werden nur die Deskriptoren für Messwerttypen zurückgegeben, deren Namen mit utilization enden.

Jetzt testen

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 über dem Abschnitt Authentifizierung 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.

Wenn Sie beispielsweise die Deskriptoren für Messwerte auflisten, die mit utilization enden, erhalten Sie dennoch viele Informationen. Wenn Sie nur den Namen des Messwerttyps und seine Beschreibung interessiert, können Sie das Feld Felder verwenden, um nur diese Felder anzugeben.

Um den Unterschied zu sehen, füllen Sie die folgenden Felder auf der Seite metricsDescriptor.list aus. Ersetzen Sie [PROJECT_ID] durch Ihre Projekt-ID, aber geben Sie die anderen Werte wie gezeigt an:

  • Name wie zuvor: projects/[PROJECT_ID]
  • Filter wie zuvor: metric.type=ends_with("utilization")
  • Felder: metricDescriptors.type,metricDescriptors.description

Bei der Ausführung dieser Anfrage wird nur der type (Kurzname) jedes Messwerts und dessen description zurückgegeben. Folgendes ist Teil der Ausgabe:

Jetzt testen

Tipps

Denken Sie daran, [PROJECT_ID] zu ändern.

Ersetzen Sie [PROJECT_ID] durch die ID Ihres Projekts. Andernfalls erhalten Sie folgendes Ergebnis:

Fehlermeldung, wenn Sie vergessen, die PROJEKT-ID zu ändern

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 Anführungszeichen ('). Ein Beispiel finden Sie unter Zusätzliche Parameter bereitstellen.
  • 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 Authentifizierung. In der Regel müssen Sie hier nichts ändern.

Der Standardauthentifizierungsmechanismus ist Google OAuth 2.0.

Im Bereich Authentifizierung 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 zu diesen Konzepten finden Sie unter Zugriffssteuerung.

Fehlerbehebung

Wenn weiterhin Probleme auftreten, lesen Sie den Abschnitt Fehlerbehebung bei der Monitoring API.