Come utilizzare la libreria Vultr Go per ottenere informazioni sul server

• introduzione
• Prerequisiti
• obiettivi
• Passaggio 1: creazione del progetto
• Passaggio 2: download della libreria
• Passaggio 3: ottenere la chiave API
• Passaggio 4: creazione del file di programma
• Passaggio 5: inizializzazione del client API
• Passaggio 6: utilizzo dell'API
• Passaggio 7: visualizzazione delle informazioni
• Passaggio 8: in esecuzione
• Conclusione

introduzione

La libreria ufficiale di Vultr Go può essere utilizzata per interagire con l' API Vultr . L'API Vultr ti consente di controllare le risorse associate al tuo account, inclusi server, DNS, firewall, snapshot, rete e altro. Questo tutorial introdurrà l'utilizzo del client ufficiale Go API creando una semplice applicazione per ottenere informazioni sui tuoi server.

Prerequisiti

• Un computer con Windows, Linux o macOS con Go 1.12+ installato.
• Conoscenza di base della programmazione.
• Facoltativo: un IDE che supporta Go (ad esempio Visual Studio Code, emacs o Atom).

obiettivi

• Per informazioni su come utilizzare la libreria API Vultr ufficiale.
• Per scrivere un programma per visualizzare le informazioni sul server.

Passaggio 1: creazione del progetto

Innanzitutto, inizieremo creando un nuovo modulo (progetto). Di solito, useresti l'URL in un repository per il tuo codice come nome del modulo, ma questo va oltre lo scopo di questo tutorial. Per ora, useremo serverinfo come nome del modulo.

Per creare il progetto, eseguire i seguenti comandi:

# Create the folder in the current directory.
mkdir serverinfo

# Enter the new folder.
cd serverinfo

# Initialize the module.
go mod init serverinfo

Passaggio 2: download della libreria

Successivamente, scaricheremo la libreria API da GitHub (un sito di hosting di codice). Per scaricare librerie, è necessario utilizzare il go getcomando Ciò scaricherà automaticamente la libreria e le sue dipendenze durante l'aggiunta al file go.mod . Nello stesso terminale che hai aperto in precedenza, inserisci il seguente comando:

go get github.com/vultr/govultr

Passaggio 3: ottenere la chiave API

Per utilizzare il client API, avrai bisogno della tua chiave API. Puoi recuperare la tua chiave API dalla scheda API della sezione Account della dashboard . Dovrai anche autorizzare il tuo indirizzo IP per usare la chiave API. Puoi trovare il tuo indirizzo IP andando su ifconfig.me . Nota che stai cercando il tuo IP pubblico , non quello privato. Il tuo IP privato è quello che potresti trovare nelle impostazioni di rete sul tuo computer e si trova in uno dei seguenti intervalli CIDR: 10.0.0.0/8 , 172.16.0.0/12 o 192.168.0.0/16 .

Una volta che hai il tuo indirizzo IP, aggiungilo nella sezione Controllo accessi . Nella casella dopo il / , digitare 32. /32è un significato di maschera di rete 255.255.255.255. Ciò significa che solo il tuo IP è incluso nell'intervallo.

Avviso: proteggi la tua chiave API come se stessi proteggendo la tua password. La chiave API ha accesso all'intero account, inclusi fatturazione, server e spazio di archiviazione.

Passaggio 4: creazione del file di programma

Ora inizieremo a lavorare sul programma. Apri la cartella che abbiamo creato nella tua scelta di editor e crea un file chiamato main.go.

All'interno del file, digitare o copiare e incollare il seguente codice:

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/vultr/govultr"
)

func main() {

}

La package maindice Go che stiamo creando un comando, non è una biblioteca. La dichiarazione di importazione dichiara le dipendenze che useremo. func main()è la funzione chiamata quando eseguiamo il nostro programma.

Passaggio 5: inizializzazione del client API

Il prossimo passo è inizializzare il client API. Per fare ciò, dobbiamo usare la funzione govultr.NewClient (http.Client, string) . Aggiungi il seguente codice all'interno della funzione main () :

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

Sostituisci YOURAPIKEYcon la chiave API recuperata in precedenza.

Diamo un'occhiata a questo codice un po 'più da vicino. Sul lato sinistro del :=, abbiamo client. Questo è il nome di una variabile . Una variabile memorizza i valori. Sul lato destro, abbiamo una chiamata di funzione a govultr.NewClient . Il primo parametro è zero, perché non è necessario modificare il client HTTP predefinito. Il secondo parametro è la chiave API che stiamo usando per autenticarci. L' :=operatore assegna il lato destro al lato sinistro, in questo caso il risultato della chiamata di funzione a client.

Passaggio 6: utilizzo dell'API

Il nostro programma continua a non fare ancora nulla. Per renderlo utile, recupereremo le informazioni sui nostri server da Vultr. Useremo la funzione govultr.Client.Server.List (context.Context) ([] govultr.Server, error) . Aggiungi il seguente codice alla fine della funzione main () :

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

In questo codice, stiamo chiamando la funzione API per recuperare le informazioni sul server. Non preoccuparti ancora del significato del contesto , poiché si tratta di un argomento più avanzato. Per ora, tutto ciò che dobbiamo sapere è che il contesto controlla come viene eseguito il client API. context.Background () restituisce un contesto vuoto . Dopo aver recuperato le informazioni del server nelle due variabili, server ed err , controlliamo se si è verificato un errore. In tal caso, informiamo l'utente dell'errore e usciamo con il codice 1 (errore).

Passaggio 7: visualizzazione delle informazioni

Ora che abbiamo una matrice di server nella variabile server ( [] govultr.Server ), possiamo effettivamente visualizzarla. Aggiungi il seguente codice alla fine della funzione main () :

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

In primo luogo il risultato della stampa (display) un colpo di testa, Servers:. Quindi, eseguiamo il ciclo sull'array di server , ignorando l'indice assegnandolo a _e assegnando il server corrente alla variabile server . All'interno del loop, visualizziamo l'etichetta del server, l'indirizzo IP, la posizione, i costi in sospeso, la larghezza di banda corrente e la larghezza di banda consentita. Per fare questo in modo efficace, usiamo stringhe di formato , la stringa che sembra " %s (%s) - %s - $%s pending charges - %.2f/%s GB bandwidth\n". I %s mezzi per sostituire la stringa successiva, mentre i %.2fmezzi per stampare il float successivo (numero decimale) arrotondato al secondo decimale. Il resto della stringa di formato viene stampato letteralmente (così com'è).

Passaggio 8: in esecuzione

A questo punto, il codice dovrebbe essere simile al seguente:

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

Ora possiamo eseguire il codice. Ritorna al terminale che abbiamo aperto in precedenza e inserisci il comando go run. L'output sarà simile al seguente:

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

Se ricevi un errore, assicurati che la chiave API e l'indirizzo IP siano corretti.

Conclusione

A questo punto, avrai appreso con successo le basi su come utilizzare il client API ufficiale e scritto un programma che visualizzerà le informazioni sui server nel tuo account.

Ulteriori passi

Da qui, puoi fare molto di più. Ad esempio, è possibile scrivere un programma per eseguire il provisioning di un nuovo server quando si ha poca memoria. Potresti scrivere un'app per aggiornare automaticamente il tuo server quando sei a corto di larghezza di banda o spazio di archiviazione. Potresti persino scrivere uno strumento per aggiornare automaticamente i record DNS in base al tuo IP attuale.

Per ulteriori informazioni sulla libreria govultr, è possibile trovare la documentazione della libreria govultr su godoc .

govultr è un progetto open source . Se trovi dei bug in govultr, puoi segnalarli su GitHub . Puoi anche contribuire direttamente al codice inviando una richiesta pull .