Ako používať knižnicu Vultr Go na získanie informácií o serveri

• Úvod
• Predpoklady
• Ciele
• Krok 1: Vytvorenie projektu
• Krok 2: Stiahnutie knižnice
• Krok 3: Získanie kľúča API
• Krok 4: Vytvorenie súboru programu
• Krok 5: Inicializácia klienta API
• Krok 6: Použitie API
• Krok 7: Zobrazenie informácií
• Krok 8: Beh
• Záver

Úvod

Na interakciu s Vultr API možno použiť oficiálnu knižnicu Vultr Go . Vultr API vám umožňuje ovládať zdroje spojené s vaším účtom, vrátane serverov, DNS, firewallu, snímok, siete a ďalších. Tento tutoriál vám poskytne úvod do používania oficiálneho klienta Go API vytvorením jednoduchej aplikácie na získanie informácií o vašich serveroch.

Predpoklady

• Počítač so systémom Windows, Linux alebo macOS s nainštalovaným Go 1.12+.
• Základné znalosti programovania.
• Voliteľné: IDE podporujúce Go (napríklad Visual Studio Code, emacs alebo Atom).

Ciele

• Ak sa chcete dozvedieť, ako používať oficiálnu knižnicu Vultr API.
• Ak chcete napísať program na zobrazenie informácií o serveri.

Krok 1: Vytvorenie projektu

Najprv začneme vytvorením nového modulu (projektu). Zvyčajne by ste ako názov modulu použili adresu URL úložiska pre váš kód, ale to je nad rámec tohto návodu. Zatiaľ budeme ako názov modulu používať serverinfo .

Ak chcete vytvoriť projekt, spustite nasledujúce prí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: Stiahnutie knižnice

Ďalej si stiahneme knižnicu API z GitHub (stránka na hosťovanie kódu). Ak chcete stiahnuť knižnice, musíte použiť go getpríkaz. Tým sa automaticky stiahne knižnica a jej závislosti pri jej pridávaní do súboru go.mod . V tom istom termináli, ktorý ste otvorili predtým, zadajte nasledujúci príkaz:

go get github.com/vultr/govultr

Krok 3: Získanie kľúča API

Ak chcete používať klienta API, budete potrebovať kľúč API. Kľúč API môžete získať na karte API v sekcii Účet na vašom informačnom paneli . Budete tiež musieť autorizovať svoju IP adresu, aby ste mohli používať kľúč API. Svoju IP adresu nájdete na ifconfig.me . Všimnite si, že hľadáte svoju verejnú IP, nie svoju súkromnú. Vaša súkromná adresa IP je to, čo by ste našli v nastaveniach siete vo svojom počítači, a nachádza sa v jednom z nasledujúcich rozsahov CIDR: 10.0.0.0/8 , 172.16.0.0/12 alebo 192.168.0.0/16 .

Keď máte svoju IP adresu, pridajte ju do sekcie Kontrola prístupu . Do poľa za znakom / zadajte 32. /32znamená masku siete 255.255.255.255. To znamená, že v rozsahu je zahrnutá iba vaša IP adresa.

Upozornenie: Chráňte svoj API kľúč tak, ako by ste chránili svoje heslo. Kľúč API má prístup k celému vášmu účtu vrátane fakturácie, serverov a úložiska.

Krok 4: Vytvorenie súboru programu

Teraz začneme pracovať na programe. Otvorte priečinok, ktorý sme vytvorili vo vašom zvolenom editore, a vytvorte súbor s názvom main.go.

Do súboru zadajte alebo skopírujte a prilepte nasledujúci kód:

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

package mainHovorí Go, že sme vytvoriť príkaz, nie knižnice. Príkaz import deklaruje závislosti, ktoré budeme používať. func main()je funkcia volaná pri spustení nášho programu.

Krok 5: Inicializácia klienta API

Ďalším krokom je inicializácia klienta API. Na to musíme použiť funkciu govultr.NewClient(http.Client, string) . Do funkcie main() pridajte nasledujúci kód :

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

Nahraďte YOURAPIKEYho kľúčom API, ktorý ste získali predtým.

Pozrime sa na tento kód trochu bližšie. Na ľavej strane :=máme client. To je názov premennej . Premenná ukladá hodnoty. Na pravej strane máme volanie funkcie govultr.NewClient . Prvý parameter je nula, pretože nepotrebujeme meniť predvoleného HTTP klienta. Druhým parametrom je kľúč API, ktorý používame na autentifikáciu. :=Prevádzkovateľ priradí správnou stranou na ľavú stranu, v tomto prípade je výsledok volanie funkcie k client.

Krok 6: Použitie API

Náš program stále nič nerobí. Aby to bolo užitočné, budeme získavať informácie o našich serveroch z Vultr. Použijeme funkciu govultr.Client.Server.List(context.Context) ([]govultr.Server, chyba) . Na koniec funkcie main() pridajte nasledujúci 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óde voláme funkciu API na získanie informácií o serveri. Netrápte sa zatiaľ významom kontextu , pretože ide o pokročilejšiu tému. Zatiaľ všetko, čo potrebujeme vedieť, je, že kontext riadi, ako beží klient API. context.Background() vracia prázdny kontext . Po získaní informácií o serveri do dvoch premenných, serverov a err , skontrolujeme, či nedošlo k chybe. Ak áno, informujeme používateľa o chybe a ukončíme s kódom 1 (chyba).

Krok 7: Zobrazenie informácií

Teraz, keď máme pole serverov v premennej servery ( []govultr.Server ), môžeme ho skutočne zobraziť. Na koniec funkcie main() pridajte nasledujúci 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, ) }

Najprv vytlačíme (zobrazíme) hlavičku, Servers:. Potom prejdeme cez pole serverov , ignorujeme index jeho priradením k _a priradíme aktuálny server k premennej servera . Vo vnútri slučky zobrazujeme štítok servera, IP adresu, umiestnenie, čakajúce poplatky, aktuálnu šírku pásma a povolenú šírku pásma. Aby sme to dosiahli efektívne, používame formátovacie reťazce , reťazec, ktorý vyzerá ako " %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n". Tieto %sprostriedky nahradiť ďalší reťazec, zatiaľ čo %.2fprostriedky pre vytlačenie ďalšie float (počet desatinných miest), zaokrúhlené na 2 desatinné miesta. Zvyšok formátovacieho reťazca sa vytlačí doslova (tak, ako je).

Krok 8: Beh

V tomto bode by mal váš kód vyzerať 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, ) } }

Teraz môžeme spustiť kód. Vráťte sa do terminálu, ktorý sme otvorili predtým, a zadajte príkaz go run. Výstup bude vyzerať takto:

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

Ak sa zobrazí chyba, uistite sa, že váš kľúč API a adresa IP sú správne.

Záver

V tomto bode sa úspešne naučíte základy používania oficiálneho klienta API a napíšete program, ktorý bude zobrazovať informácie o serveroch vo vašom účte.

Ďalšie kroky

Odtiaľ môžete urobiť oveľa viac. Môžete napríklad napísať program na zabezpečenie nového servera, keď máte málo pamäte. Môžete napísať aplikáciu, ktorá automaticky aktualizuje váš server, keď máte málo šírky pásma alebo úložiska. Môžete dokonca napísať nástroj na automatickú aktualizáciu záznamov DNS na základe vašej aktuálnej adresy IP.

Viac informácií o knižnici govultr nájdete v dokumentácii knižnice govultr na godoc .

govultr je projekt s otvoreným zdrojovým kódom . Ak nájdete nejaké chyby v govultr, môžete ich nahlásiť na GitHub . Do kódu môžete prispieť aj priamo odoslaním žiadosti o stiahnutie .