Jak používat knihovnu Vultr Go k získání informací o serveru

• Úvod
• Předpoklady
• Cíle
• Krok 1: Vytvoření projektu
• Krok 2: Stažení knihovny
• Krok 3: Získání klíče API
• Krok 4: Vytvoření souboru programu
• Krok 5: Inicializace klienta API
• Krok 6: Použití API
• Krok 7: Zobrazení informací
• Krok 8: Běh
• Závěr

Úvod

Oficiální knihovnu Vultr Go lze použít k interakci s Vultr API . Vultr API vám umožňuje ovládat zdroje spojené s vaším účtem, včetně serverů, DNS, firewallu, snímků, sítě a dalších. Tento tutoriál poskytne úvod do používání oficiálního klienta Go API vytvořením jednoduché aplikace pro získání informací o vašich serverech.

Předpoklady

• Počítač se systémem Windows, Linux nebo macOS s nainstalovaným Go 1.12+.
• Základní znalosti programování.
• Volitelné: IDE podporující Go (například Visual Studio Code, emacs nebo Atom).

Cíle

• Chcete-li se dozvědět, jak používat oficiální knihovnu Vultr API.
• Chcete-li napsat program pro zobrazení informací o serveru.

Krok 1: Vytvoření projektu

Nejprve začneme vytvořením nového modulu (projektu). Obvykle byste jako název modulu použili adresu URL úložiště pro váš kód, ale to je nad rámec tohoto kurzu. Prozatím budeme jako název modulu používat serverinfo .

Chcete-li vytvořit projekt, spusťte následující příkazy:

# Create the folder in the current directory. mkdir serverinfo # Enter the new folder. cd serverinfo # Initialize the module. go mod init serverinfo

Krok 2: Stažení knihovny

Dále si stáhneme knihovnu API z GitHubu (web pro hostování kódu). Chcete-li stáhnout knihovny, musíte použít go getpříkaz. Tím se automaticky stáhne knihovna a její závislosti při jejím přidání do souboru go.mod . Ve stejném terminálu, který jste otevřeli dříve, zadejte následující příkaz:

go get github.com/vultr/govultr

Krok 3: Získání klíče API

Chcete-li používat klienta API, budete potřebovat svůj klíč API. Svůj klíč API můžete získat na kartě API v sekci Účet na vašem Dashboardu . Budete také muset autorizovat svou IP adresu, abyste mohli používat klíč API. Svou IP adresu najdete na ifconfig.me . Všimněte si, že hledáte svou veřejnou IP, ne svou soukromou. Vaše soukromá IP je to, co byste našli v nastavení sítě na svém počítači, a je v jednom z následujících rozsahů CIDR: 10.0.0.0/8 , 172.16.0.0/12 nebo 192.168.0.0/16 .

Jakmile budete mít svou IP adresu, přidejte ji do sekce Řízení přístupu . Do pole za / zadejte 32. /32je význam masky sítě 255.255.255.255. To znamená, že v rozsahu je zahrnuta pouze vaše IP adresa.

Upozornění: Chraňte svůj API klíč stejně jako své heslo. Klíč API má přístup k celému vašemu účtu, včetně fakturace, serverů a úložiště.

Krok 4: Vytvoření souboru programu

Nyní začneme pracovat na programu. Otevřete složku, kterou jsme vytvořili ve vašem zvoleném editoru, a vytvořte soubor s názvem main.go.

Do souboru zadejte nebo zkopírujte a vložte následující kód:

package main import ( "context" "fmt" "os" "github.com/vultr/govultr" ) func main() { }

package mainŘíká Go, že jsme vytvořit příkaz, ne knihovny. Příkaz import deklaruje závislosti, které budeme používat. func main()je funkce volaná při spuštění našeho programu.

Krok 5: Inicializace klienta API

Dalším krokem je inicializace klienta API. K tomu musíme použít funkci govultr.NewClient(http.Client, string) . Do funkce main() přidejte následující kód :

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

Nahraďte YOURAPIKEYklíčem API, který jste získali dříve.

Podívejme se na tento kód trochu blíže. Na levé straně :=máme client. To je název proměnné . Proměnná ukládá hodnoty. Na pravé straně máme volání funkce govultr.NewClient . První parametr je nula, protože nepotřebujeme měnit výchozího HTTP klienta. Druhým parametrem je klíč API, který používáme k autentizaci. :=Provozovatel přiřadí správnou stranou na levou stranu, v tomto případě je výsledek volání funkce k client.

Krok 6: Použití API

Náš program stále nic nedělá. Aby to bylo užitečné, budeme získávat informace o našich serverech z Vultr. Použijeme funkci govultr.Client.Server.List(context.Context) ([]govultr.Server, chyba) . Na konec funkce main() přidejte následující kód :

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

V tomto kódu voláme funkci API k načtení informací o serveru. S významem kontextu si zatím hlavu nelámejte , protože jde o pokročilejší téma. V tuto chvíli potřebujeme vědět jen to, že kontext řídí běh klienta API. context.Background() vrací prázdný kontext . Poté, co načteme informace o serveru do dvou proměnných, servers a err , zkontrolujeme, zda nedošlo k chybě. Pokud ano, informujeme uživatele o chybě a ukončíme s kódem 1 (chyba).

Krok 7: Zobrazení informací

Nyní, když máme pole serverů v proměnné servers ( []govultr.Server ), můžeme ji skutečně zobrazit. Na konec funkce main() přidejte následující kód :

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, ) }

Nejprve vytiskneme (zobrazíme) záhlaví, Servers:. Potom provedeme smyčku přes pole serverů , ignorujeme index jeho přiřazením k _a přiřadíme aktuální server k proměnné serveru . Uvnitř smyčky zobrazujeme štítek serveru, IP adresu, umístění, nevyřízené poplatky, aktuální šířku pásma a povolenou šířku pásma. Abychom toho dosáhli efektivně, používáme formátovací řetězce , řetězec, který vypadá jako " %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n". Tyto %sprostředky nahradit další řetězec, zatímco %.2fprostředky pro vytištění další float (počet desetinných míst), zaokrouhleno na 2 desetinná místa. Zbytek formátovacího řetězce je vytištěn doslova (tak jak je).

Krok 8: Běh

V tomto okamžiku by váš kód měl vypadat takto:

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, ) } }

Nyní můžeme spustit kód. Vraťte se do terminálu, který jsme otevřeli dříve, a zadejte příkaz go run. Výstup bude vypadat následovně:

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

Pokud se zobrazí chyba, ujistěte se, že váš klíč API a adresa IP jsou správné.

Závěr

V tomto bodě se úspěšně naučíte základy používání oficiálního API klienta a napíšete program, který bude zobrazovat informace o serverech ve vašem účtu.

Další kroky

Odtud můžete udělat mnohem více. Můžete například napsat program pro zřízení nového serveru, když máte málo paměti. Můžete napsat aplikaci, která automaticky upgraduje váš server, když máte málo šířky pásma nebo úložiště. Můžete dokonce napsat nástroj pro automatickou aktualizaci DNS záznamů na základě vaší aktuální IP adresy.

Další informace o knihovně govultr najdete v dokumentaci knihovny govultr na godoc .

govultr je projekt s otevřeným zdrojovým kódem . Pokud v govultr najdete nějaké chyby, můžete je nahlásit na GitHubu . Můžete také přispět ke kódu přímo odesláním žádosti o stažení .