So verwenden Sie die Vultr Go-Bibliothek, um Serverinformationen abzurufen

• Einführung
• Voraussetzungen
• Tore
• Schritt 1: Erstellen des Projekts
• Schritt 2: Herunterladen der Bibliothek
• Schritt 3: Abrufen Ihres API-Schlüssels
• Schritt 4: Erstellen der Programmdatei
• Schritt 5: Initialisieren des API-Clients
• Schritt 6: Verwenden der API
• Schritt 7: Anzeigen der Informationen
• Schritt 8: Laufen
• Fazit

Einführung

Die offizielle Vultr Go-Bibliothek kann zur Interaktion mit der Vultr- API verwendet werden . Mit der Vultr-API können Sie die mit Ihrem Konto verknüpften Ressourcen steuern, einschließlich Server, DNS, Firewall, Snapshots, Netzwerk und mehr. Dieses Tutorial bietet eine Einführung in die Verwendung des offiziellen Go API-Clients, indem Sie eine einfache Anwendung erstellen, um Informationen zu Ihren Servern abzurufen.

Voraussetzungen

• Ein Computer unter Windows, Linux oder MacOS mit installiertem Go 1.12+.
• Grundlegende Programmierkenntnisse.
• Optional: Eine IDE, die Go unterstützt (z. B. Visual Studio Code, Emacs oder Atom).

Tore

• Erfahren Sie, wie Sie die offizielle Vultr-API-Bibliothek verwenden.
• So schreiben Sie ein Programm zum Anzeigen von Serverinformationen.

Schritt 1: Erstellen des Projekts

Zunächst erstellen wir ein neues Modul (Projekt). Normalerweise verwenden Sie die URL zu einem Repository für Ihren Code als Modulnamen, dies geht jedoch über den Rahmen dieses Lernprogramms hinaus. Im Moment werden wir serverinfo als Modulnamen verwenden .

Führen Sie die folgenden Befehle aus, um das Projekt zu erstellen:

# Create the folder in the current directory.
mkdir serverinfo

# Enter the new folder.
cd serverinfo

# Initialize the module.
go mod init serverinfo

Schritt 2: Herunterladen der Bibliothek

Als nächstes werden wir die API-Bibliothek von GitHub (einer Code-Hosting-Site) herunterladen. Um Bibliotheken herunterzuladen, müssen Sie den go getBefehl verwenden. Dadurch werden die Bibliothek und ihre Abhängigkeiten automatisch heruntergeladen, während sie der Datei go.mod hinzugefügt werden. Geben Sie im selben Terminal, das Sie zuvor geöffnet haben, den folgenden Befehl ein:

go get github.com/vultr/govultr

Schritt 3: Abrufen Ihres API-Schlüssels

Um den API-Client verwenden zu können, benötigen Sie Ihren API-Schlüssel. Sie können Ihren API-Schlüssel auf der Registerkarte API im Abschnitt Konto Ihres Dashboards abrufen . Sie müssen auch Ihre IP-Adresse autorisieren, um den API-Schlüssel verwenden zu können. Sie finden Ihre IP-Adresse unter ifconfig.me . Beachten Sie, dass Sie nach Ihrer öffentlichen IP- Adresse suchen , nicht nach Ihrer privaten. Ihre private IP- Adresse befindet sich in Ihren Netzwerkeinstellungen auf Ihrem Computer und liegt in einem der folgenden CIDR-Bereiche: 10.0.0.0/8 , 172.16.0.0/12 oder 192.168.0.0/16 .

Wenn Sie Ihre IP-Adresse haben, fügen Sie sie im Abschnitt Zugriffssteuerung hinzu . In der Box nach dem / geben 32. /32ist eine Netzmaskenbedeutung 255.255.255.255. Dies bedeutet, dass nur Ihre IP im Bereich enthalten ist.

Warnung: Schützen Sie Ihren API-Schlüssel so, als würden Sie Ihr Passwort schützen. Der API-Schlüssel hat Zugriff auf Ihr gesamtes Konto, einschließlich Abrechnung, Server und Speicher.

Schritt 4: Erstellen der Programmdatei

Jetzt werden wir mit der Arbeit an dem Programm beginnen. Öffnen Sie den Ordner, den wir in einem Editor Ihrer Wahl erstellt haben, und erstellen Sie eine Datei mit dem Namen main.go.

Geben Sie in die Datei den folgenden Code ein oder kopieren Sie ihn:

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/vultr/govultr"
)

func main() {

}

Das package mainsagt Go, dass wir einen Befehl erstellen, keine Bibliothek. Die import-Anweisung deklariert die Abhängigkeiten, die wir verwenden werden. func main()ist die Funktion, die aufgerufen wird, wenn wir unser Programm ausführen.

Schritt 5: Initialisieren des API-Clients

Der nächste Schritt ist die Initialisierung des API-Clients. Dazu müssen wir die Funktion govultr.NewClient (http.Client, string) verwenden. Fügen Sie den folgenden Code in die Funktion main () ein :

client := govultr.NewClient(nil, "YOURAPIKEY")

Ersetzen Sie ihn YOURAPIKEYdurch den zuvor abgerufenen API-Schlüssel.

Schauen wir uns diesen Code etwas genauer an. Auf der linken Seite :=haben wir client. Das ist der Name einer Variablen . Eine Variable speichert Werte. Auf der rechten Seite haben wir einen Funktionsaufruf an govultr.NewClient . Der erste Parameter ist nil, da wir den Standard-HTTP-Client nicht ändern müssen. Der zweite Parameter ist der API-Schlüssel, mit dem wir uns authentifizieren. Der :=Bediener ordnet die rechte Seite der linken Seite zu, in diesem Fall das Ergebnis des Funktionsaufrufs an client.

Schritt 6: Verwenden der API

Unser Programm macht noch nichts. Um es nützlich zu machen, werden wir Informationen über unsere Server von Vultr abrufen. Wir werden die Funktion govultr.Client.Server.List (context.Context) ([] govultr.Server, error) verwenden. Fügen Sie am Ende der Funktion main () den folgenden Code hinzu :

servers, err := client.Server.List(context.Background())
if err != nil {
    fmt.Fprintf(os.Stderr, "Error: %v\n", err)
    os.Exit(1)
}

In diesem Code rufen wir die API-Funktion auf, um die Serverinformationen abzurufen. Machen Sie sich noch keine Sorgen über die Bedeutung des Kontexts , da dies ein fortgeschritteneres Thema ist. Im Moment müssen wir nur wissen, dass der Kontext die Ausführung des API-Clients steuert. context.Background () gibt einen leeren Kontext zurück . Nachdem wir die Serverinformationen in die beiden Variablen server und err abgerufen haben , prüfen wir, ob ein Fehler aufgetreten ist. Wenn ja, informieren wir den Benutzer über den Fehler und beenden mit Code 1 (Fehler).

Schritt 7: Anzeigen der Informationen

Nun , da wir eine Reihe von Servern in der haben Server - Variable ( [] govultr.Server ), können wir es tatsächlich angezeigt werden soll . Fügen Sie am Ende der Funktion main () den folgenden Code hinzu :

fmt.Println("Servers:")
for _, server := range servers {
    fmt.Printf("  %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n",
        server.Label,
        server.MainIP,
        server.Location,
        server.PendingCharges,
        server.CurrentBandwidth,
        server.AllowedBandwidth,
    )
}

Zuerst drucken wir einen Header Servers:. Dann wir Schleife über die Server - Array, Ignorieren des Index , indem es die Zuordnung _und den aktuellen Server zu dem Zuweisen Server Variable. Innerhalb der Schleife zeigen wir die Bezeichnung des Servers, die IP-Adresse, den Standort, die ausstehenden Gebühren, die aktuelle Bandbreite und die zulässige Bandbreite an. Um dies zu efficently tun, verwenden wir Formatstrings , die Zeichenfolge , die wie folgt aussieht " %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n". Das %s Mittel zum Ersetzen der nächsten Zeichenfolge, während das %.2fMittel zum Drucken des nächsten Gleitkommas (Dezimalzahl) auf 2 Dezimalstellen gerundet ist. Der Rest der Formatzeichenfolge wird buchstäblich (wie sie ist) gedruckt.

Schritt 8: Laufen

Zu diesem Zeitpunkt sollte Ihr Code wie folgt aussehen:

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/vultr/govultr"
)

func main() {
    client := govultr.NewClient(nil, "YOURAPIKEY")

    servers, err := client.Server.List(context.Background())
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error: %v\n", err)
        os.Exit(1)
    }

    fmt.Println("Servers:")
    for _, server := range servers {
        fmt.Printf("  %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n",
            server.Label,
            server.MainIP,
            server.Location,
            server.PendingCharges,
            server.CurrentBandwidth,
            server.AllowedBandwidth,
        )
    }
}

Wir können jetzt den Code ausführen. Kehren Sie zu dem zuvor geöffneten Terminal zurück und geben Sie den Befehl ein go run. Die Ausgabe ähnelt der folgenden:

Servers:
  server1 (198.51.100.4) - New Jersey - $3.70 pending charges - 17.64/1000 GB bandwidth
  server2 (198.51.100.9) - Toronto - $1.70 pending charges - 3.24/500 GB bandwidth

Wenn Sie eine Fehlermeldung erhalten, stellen Sie sicher, dass Ihr API-Schlüssel und Ihre IP-Adresse korrekt sind.

Fazit

Zu diesem Zeitpunkt haben Sie die Grundlagen der Verwendung des offiziellen API-Clients erfolgreich erlernt und ein Programm geschrieben, das Informationen zu den Servern in Ihrem Konto anzeigt.

Weitere Schritte

Von hier aus können Sie noch viel mehr tun. Sie können beispielsweise ein Programm schreiben, um einen neuen Server bereitzustellen, wenn Sie wenig Speicher haben. Sie können eine App schreiben, um Ihren Server automatisch zu aktualisieren, wenn Sie wenig Bandbreite oder Speicherplatz haben. Sie können sogar ein Tool schreiben, um DNS-Einträge basierend auf Ihrer aktuellen IP automatisch zu aktualisieren.

Weitere Informationen zur govultr-Bibliothek finden Sie in der Dokumentation zur govultr- Bibliothek auf godoc .

govultr ist ein Open-Source-Projekt . Wenn Sie Fehler in govultr finden, können Sie diese auf GitHub melden . Sie können auch direkt zum Code beitragen, indem Sie eine Pull-Anfrage senden .