Zusammenstellen einer Abfrage in GraphiQL

Sie können einen GraphiQL verwenden, um eine GraphQL zusammenzustellen und auszuführen.

Einrichten einer Abfrage und Auswahl eines Datensatzes

Klicken Sie auf den Bearbeitungsbereich von GraphiQL und fügen Sie die folgende abgebildete Basisabfrage hinzu, wobei Sie zone-id durch Ihre Cloudflare-Zonen-ID ersetzen:

Um das Tag der Zone zu finden, loggen Sie sich in Ihr Cloudflare-Konto ein und wählen Sie die Website aus, für die Sie das Tag erhalten möchten. Scrollen Sie auf der Übersichtsseite des Cloudflare-Dashboards zum Abschnitt API in der rechten Seitenleiste. Hier werden Ihre Zonen- und Kontotags angezeigt.

Um die Erstellung von Abfragen zu unterstützen, verfügt der GraphiQL über eine Wortvervollständigung. Setzen Sie den Cursor in die Abfrage, in diesem Fall in die Zeile unter ' zones, und beginnen Sie mit der Eingabe eines Wertes, um das Merkmal zu aktivieren. Wenn Sie z. B. " firewall eingeben, zeigt ein Popup-Menü die Datensätze an, die Firewall-Informationen liefern:

Der Text am unteren Ende der Liste enthält eine kurze Beschreibung der Daten, die der Knoten zurückgibt.

Wählen Sie den Datensatz, den Sie abfragen möchten, und fügen Sie ihn ein. Wählen Sie entweder das Element in der Liste aus, oder blättern Sie mit den Pfeiltasten und drücken Sie die Eingabetaste.

Gewünschte Parameter liefern

Bewegen Sie den Mauszeiger über ein Feld, um eine QuickInfo mit einer Beschreibung des Datensatzes anzuzeigen. Wenn Sie in diesem Beispiel den Mauszeiger über den Knoten " firewallEventsAdaptive bewegen, wird die hier abgebildete Beschreibung angezeigt:

Wählen Sie den Namen des Datensatzes (blauer Text), um Informationen über den Datensatz, einschließlich der erforderlichen Parameter, anzuzeigen. Der Dokumentations-Explorer wird geöffnet und zeigt Details über den Datensatz an:

Die Argumente " filter und " limit sind erforderlich, was durch das Ausrufezeichen (!) hinter ihren Typdefinitionen (goldener Text) angezeigt wird. In diesem Beispiel ist das Argument " orderBy nicht erforderlich, obwohl es bei Verwendung einen Wert vom Typ " ZoneFirewallEventsAdaptiveOrderBy erfordert.

Um eine Liste der unterstützten Filterfelder zu durchsuchen, wählen Sie im Dokumentations-Explorer die Definition des Filtertyps (goldener Text). In diesem Beispiel ist der Typ " ZoneFirewallEventsAdaptiveFilter_InputObject:

Die folgende Beispielabfrage zeigt die erforderlichen ' filter und ' limit für ' firewallEventsAdaptive (wie auch für die übrigen GraphQL ):

Definieren Sie die von Ihrer Abfrage verwendeten Felder

Um die Felder zu durchsuchen, die Sie mit Ihrer Abfrage verwenden können, bewegen Sie den Mauszeiger über den Namen des Datensatzes und die angezeigte QuickInfo. Wählen Sie dann die Datentypdefinition (goldener Text):

Der Dokumentations-Explorer wird geöffnet und zeigt eine Liste von Feldern an:

Um die zu lesenden Datenfelder hinzuzufügen, geben Sie eine öffnende geschweifte Klammer ({) nach der schließenden Klammer für die Parameter ein und beginnen dann mit der Eingabe des Namens des Feldes, das Sie abrufen möchten. Verwenden Sie die Wortvervollständigung, um ein Feld auszuwählen.

Die folgende Beispielabfrage gibt die Felder " action, " datetime, " clientRequestHTTPHost und " userAgent zurück:

Wenn Sie alle Felder, die Sie abfragen möchten, eingegeben haben, wählen Sie die Schaltfläche Abspielen, um die Abfrage zu senden. Das Antwortfenster enthält die vom konfigurierten GraphQL abgerufenen Daten:

Variablensubstitution

Der GraphiQL erlaubt es, Platzhalter für Werte zu verwenden und diese über den ' variables-Teil der Payload zu liefern.

Die Namen von Platzhaltern sollten mit dem Zeichen ' $ beginnen, und Sie brauchen Platzhalter nicht in Anführungszeichen zu setzen, wenn Sie sie in der Abfrage verwenden.

Die Werte für die Platzhalter sollten im JSON-Format angegeben werden, wobei die Platzhalter ohne das Zeichen " $ angesprochen werden. Als Beispiel für einen Platzhalter ' $zoneTag liest die GraphQL einen Wert aus dem Feld ' zoneTag des übergebenen Variablenobjekts.

Um einen Wert für einen Platzhalter anzugeben, wählen Sie den Bereich Abfragevariablen und bearbeiten ein JSON-Objekt, das Ihre Variablen definiert.

Diese Beispielabfrage verwendet die Abfragevariable ' zoneTag ', um die Zonen-ID darzustellen: