Pitchfork – die Rackspace Cloud API-Webanwendung

Wenn Sie auf interaktive Weise auf die Dokumentation verweisen und API-Befehle für Rackspace Cloud-Produkte ausführen möchten, schnell mit einem Produkt interagieren müssen oder neue Produkte oder Funktionen nutzen möchten, die nicht im Control Panel verfügbar sind, ist Pitchfork möglicherweise das richtige Tool dafür Sie.

Pitchfork ist eine interaktive Web-API-Anwendung, die es einem Benutzer ermöglicht, schnell mit Rackspace Cloud-Produkten zu interagieren. Es ist nicht erforderlich, eine Eingabeaufforderung aufzurufen oder nachzuschlagen, wie Datenobjekte mithilfe eines cURL-Befehls gesendet werden. Die Anwendung erledigt all dies für Sie und zeigt die Ergebnisse und Antworten der Produkt-API-Anforderungen an, die Sie für Ihr Cloud-Konto gestellt haben.

Pitchfork wurde entwickelt, um die API-Aufrufe durchzuführen und Ihnen zu zeigen, was Sie für API-Aufrufe benötigen, damit Sie sie mit anderen Tools oder Methoden ausführen können. Sie können die Mock-Funktion verwenden, um die Datenstruktur für einen Anruf zu überprüfen, was als Referenztool in Ihren Rackspace-API-Programmen dienen kann.

APIs können für Anfänger verwirrend sein. Da Pitchfork die Anrufstruktur für Sie festlegt, können Sie viel schneller lernen. Manchmal ist die API die einzige Möglichkeit, beispielsweise eine Konfigurationsänderung an einem Load Balancer oder einer Cloud-Datenbank vorzunehmen, und Pitchfork kann Ihnen sowohl zeigen, wie Sie den Aufruf tätigen, als auch ihn für Sie ausführen.

Wo ist Pitchfork zu finden

Sie können auf Pitchfork unter der folgenden Adresse zugreifen:https://pitchfork.rax.io

Sehen Sie sich den Code in GitHub an.

Login-Anforderungen

Sie müssen sich nicht bei der Anwendung anmelden, um einen der API-Aufrufe zu simulieren oder zu durchsuchen. Sie müssen sich nur anmelden, wenn Sie diese Aufrufe für Ihr Konto ausführen möchten.

Klicken Sie zum Anmelden auf Anmelden und geben Sie Ihre Authentifizierungsdaten ein.

Authentifizierung

Pitchfork verwendet dieselben Anmeldeinformationen, die Sie in einer API-Authentifizierungsanforderung an Rackspace Cloud verwenden. Sie geben Ihren Benutzernamen und API-Schlüssel an, und das System stellt die Authentifizierungsanforderung für Sie über HTTPS. Wenn die Anforderung erfolgreich ist, speichert die Anwendung das zurückgegebene Token und den Dienstkatalog und lässt die Sitzung zusammen mit dem Token zum gegebenen Zeitpunkt ablaufen.

Verwenden Sie Pitchfork, um einen API-Aufruf zu senden

Führen Sie nach der Anmeldung die folgenden Schritte aus, um einen API-Aufruf mit Pitchfork zu senden:

1. Durchsuchen Sie eines der Produkte und suchen Sie den Aufruf, den Sie ausführen möchten.
2. Wählen Sie die Region aus, mit der Sie interagieren möchten.
3. Klicken Sie auf Details .
4. Wenn es Variablen für den Anruf gibt, geben Sie sie ein.
5. Klicken Sie auf API-Aufruf senden .

Die Anwendung zeigt Ihnen die folgenden Informationen:

• Anfrage-URL: Die vollständig erstellte URL, an die Sie den Aufruf gesendet haben.

• Anfrage-Header: Der Header-Teil der Anfrage, die Sie an die API gesendet haben.

• Datenobjekt anfordern: Wenn für den Anruf ein Datenobjekt erstellt wurde, wird es mit den von Ihnen angegebenen Werten angezeigt.

• Antwort-Header: Die in der Antwort von der API empfangenen Header.

• Antworttext: Die Antwortdaten vom API-Server. Diese Antwort kann einen Statuscode, ein zurückgegebenes Objekt oder eine Fehlermeldung enthalten.

• Hinweis: Response-Header und der Response-Body werden nur für ausgeführte Anrufe und nicht für Call-Mocks angezeigt. Da Mocks nicht ausgeführt werden, muss keine Antwort angezeigt werden.

Mocks

Mit der Mock-Option können Sie einen Anruf erstellen, ohne ihn auszuführen, sodass Sie sehen können, wie der Anruf aufgebaut ist. Klicken Sie auf Mock-API-Aufruf wenn Sie alle Anfragedetails für einen Anruf sehen möchten. Das Anforderungsdatenobjekt, falls vorhanden, wird mit allen für den Aufruf verfügbaren Optionen angezeigt, und Sie können als Referenz sehen, wie das Objekt aufgebaut ist.

Warnhinweise für die Anrufausführung

Wenn Sie angemeldet sind, werden die Aufrufe für Ihr Cloud-Konto ausgeführt. Es gibt Hinweise zu den Anrufen, die Sie warnen, wenn Sie etwas tun, das sich auf die Abrechnung auswirkt. Seien Sie also vorsichtig, wenn Sie die Anrufe ausführen.

Wenn Sie einen Aufruf simulieren, wird kein API-Aufruf ausgeführt, sodass Ihr Konto nicht beeinträchtigt wird.

Anrufliste

Sie können den Verlauf Ihrer getätigten Anrufe ganz einfach anzeigen, indem Sie auf Verlauf klicken im Menü. Der Verlauf zeigt Ihre getätigten Anrufe mit allen Details an. Der Verlauf wird für Aufrufe gespeichert, die Sie gegen die API ausgeführt haben, unabhängig von der Antwort. Schein-API-Aufrufe werden nicht in Ihrem Verlauf aufgezeichnet. Sie müssen angemeldet sein, um Ihren Verlauf anzuzeigen.

Der Anrufverlauf wird gespeichert, damit Sie vergangene Anrufe innerhalb des Systems überprüfen oder darauf verweisen können. Dies ist hilfreich, wenn mehrere Benutzer dieselben Anmeldeinformationen verwenden. Der Anrufverlauf umfasst die folgenden Elemente:

• Abgeschlossen: Der Zeitstempel des Anrufs (UTC-Zeitzone).

• Anrufdetails: Details zum Aufruf, einschließlich Beschreibung, Dokumentations-URL und Titel.

• Region: Die Region, in der Sie den Aufruf ausgeführt haben, z. B. DFW oder ORD.

• Anfrage: Zu den Teilen der Anforderung, die zu Referenzzwecken gespeichert werden, gehören die URL, das Verb und alle Datenobjekte, die an die API übergeben werden.

• Antwort: Der Antworttext, die Antwortheader und der Antwortcode.

• Benutzername: Der Benutzername des Benutzers, der die Aufrufe für die API ausführt.

• Kontonummer: Die Cloud-Kontonummer.

Häufig wiederholte Anrufe

Wenn Sie einen Anruf haben, den Sie häufig ausführen, klicken Sie auf das Sternsymbol neben dem Anruf. Dadurch wird er zu Ihren Favoriten hinzugefügt, und Sie können auf diese Anrufe von der Startseite oder von Favoriten aus zugreifen im Menü. Sie können Ihre Favoriten nur hinzufügen oder anzeigen, wenn Sie bei der Anwendung angemeldet sind.