2016
November
03
2016

Workflow-Automation mit unserer neuen API

Viele Projekte umfassen schon nach kurzer Zeit mehrere virtuelle Server, z.B. um Entwicklungs-, Test- und Produktivumgebungen voneinander zu trennen, zum Testen von neuen Software-Versionen, oder indem zur Bewältigung von Lastspitzen zusätzliche Server hinzugefügt werden. Dank unserer neuen API können Sie Ihre Abläufe jetzt vereinfachen und beschleunigen, indem Sie das Erstellen neuer Server direkt in Ihr Konfigurations-Management oder Ihre bestehenden Scripts integrieren.

Nur ein Schritt zur Vorbereitung

Um unsere API nutzen zu können, benötigen Sie lediglich ein API-Token: Eine geheime Zeichenfolge, die Sie in all Ihren API-Aufrufen mitschicken müssen.

In den Account-Settings unseres Cloud-Control-Panels können Sie beliebig viele API-Tokens erstellen. Um ausschliesslich Informationen auszulesen ist "read access" eine sichere Wahl. Wenn Sie über die API auch Änderungen vornehmen möchten (z.B. Server erstellen oder neu starten), aktivieren Sie zusätzlich "write access".

Wählen Sie einen aussagekräftigen Namen, um Ihre Tokens voneinander unterscheiden zu können. Sollten Sie später ein Token widerrufen wollen, lässt es sich darüber einfach identifizieren. Da wir Ihre Tokens nur als Hash in unserer Datenbank ablegen, können diese später nicht erneut angezeigt werden.

So benutzen Sie unsere API

Unsere API ist als HTTPS API nach dem REST-Paradigma konzipiert und deshalb mit grosser Wahrscheinlichkeit auch mit Ihren bevorzugten Tools kompatibel. Ein einfaches Beispiel: Mit folgendem Befehl können Sie sich direkt von Ihrer lokalen Kommandozeile aus eine Liste Ihrer aktuellen Server anzeigen lassen:

curl -H 'Authorization: Bearer IhrCloudscaleApiToken' https://api.cloudscale.ch/v1/servers

Benötigte Parameter können Sie in JSON- oder URL-codierter Form übergeben. Die von der API ausgegebenen Informationen sind als JSON formatiert, um sie einfach auswerten und weiterverarbeiten zu können. Die Dokumentation aller verfügbaren Funktionen finden Sie unter https://www.cloudscale.ch/en/api, inklusive jeweiliger HTTP-Methode, Parameter und eines Beispiels.

Einige Anwendungsfälle und Hinweise

Die möglichen Anwendungsfälle für unsere API sind endlos: Wenn Ihre Mitarbeiter immer wieder dieselben, standardisierten Infrastrukturen aufsetzen müssen, können Sie sie nun mit einem Script unterstützen und dabei unsere API sowie die cloud-config Funktion nutzen. Vielleicht möchten Sie auch Informationsabfragen automatisieren – für Ihre Projektmitarbeiter, zur Dokumentation oder für ein Live-Dashboard.

Beachten Sie, dass alle API-Aufrufe ohne Rückfrage ausgeführt werden, um sie auch in automatisierter Form zuverlässig benutzen zu können. Da Ihre API-Tokens mit einem Passwort vergleichbar sind, sollten Sie vorsichtig sein, wo Sie sie abspeichern (z.B. offene Repositories) und wer darauf Zugriff hat (z.B. Script-Pfade oder Kommando-Historie). Sollte es dennoch nötig sein, können Sie Tokens jederzeit widerrufen.

Neu erhalten Sie beim Löschen eines Servers eine Pro-Rata-Gutschrift für die verbleibende Dauer unserer 24-stündigen Abrechnungsperiode. Testen Sie unbesorgt verschiedene Setups und Funktionen und ersetzen Sie ältere Server kostenneutral durch eine frische Installation. Wenn Sie für periodische Lastspitzen jeweils kurzfristig mehr Server in Betrieb nehmen, profitieren Sie von dieser Neuerung selbstverständlich gleichermassen.


Wir entwickeln unser Cloud-Control-Panel ständig weiter, damit die Nutzung für unsere Mitmenschen möglichst einfach ist. Umso mehr freut es uns, dass cloudscale.ch jetzt sogar von Computern einfach benutzt werden kann.

Viel Spass beim Automatisieren!
Ihr cloudscale.ch-Team


PS: Falls Sie wie wir auf Python setzen: Wir arbeiten daran, in eine der nächsten Versionen von Libcloud aufgenommen zu werden, um so den Zugriff auf unsere API weiter zu vereinfachen. Weitere Infos folgen.

Zurück zur Übersicht