Configurazione del tuo ambiente API e CLI

Prima di poter creare un VPC (IBM Cloud® Virtual Private Cloud) utilizzando l'API o la CLI, configura il tuo ambiente.

Prerequisiti generali

Configura il tuo account per accedere al VPC. Assicurati che il tuo account sia stato aggiornato a un account a pagamento.
Assicurati di avere una chiave SSH pubblica, che verrà utilizzata per la connessione alla VSI (virtual server instance). Ad esempio, genera una chiave SSH sul tuo server Linux eseguendo questo comando:
```
ssh-keygen -t rsa
```
Questo comando genera due file. La chiave pubblica generata si trova nel file id_rsa.pub , all'interno della directory ``.ssh`` nella tua directory home; ad esempio, ` ``.../.ssh/id_rsa.pub```.

Per ulteriori informazioni, vedi Chiavi SSH.

Prerequisiti CLI

Prima di poter utilizzare la CLI per creare il tuo VPC, devi installare la CLI IBM Cloud e il plug-in CLI VPC.

Deprecato IBM Cloud CLI non è supportata su LinuxONE (architettura del processore s390x ). Tuttavia, è possibile installare la CLI su un'altra piattaforma supportata e utilizzarla con le istanze del server virtuale LinuxONE (architettura del processore s390x ).

Installa la CLIIBM Cloud.
Installa il plug-in CLI VPC.
```
ibmcloud plugin install vpc-infrastructure
```
Le azioni CLI VPC utilizzano l'estensione is. Per imparare a utilizzare i comandi CLI, puoi eseguire:
```
ibmcloud is help
ibmcloud is help vpc-create
ibmcloud is help instance-create
```
Per scoprire come creare risorse utilizzando la CLI, consulta la sezione Creazione di risorse VPC.

Accesso alla CLI tramite l'endpoint privato dell'API VPC

Per impostare la CLI per utilizzare l'endpoint privato dell'API VPC, attieniti alla seguente procedura:

Per scaricare la CLI di IBM Cloud e i plug-in associati, è necessario poter accedere al repository pubblico in cui si trovano.

Assicurati che la CLI IBM Cloud principale e il plug-in del servizio dell'infrastruttura VPC siano aggiornati all'ultima versione:
```
ibmcloud update
ibmcloud plugin update vpc-infrastructure
```
Per passare alla modalità endpoint privato API, immettere il seguente comando:
```
ibmcloud login -a private.cloud.ibm.com
```
Attualmente, la modalità endpoint privato API supporta solo le regioni us-south e us-east.

Prerequisiti API

Prima di poter utilizzare l'API per creare il tuo VPC, devi ottenere un token IAM, memorizzare l'endpoint come una variabile e verificare di avere accesso al servizio API VPC.

I seguenti esempi utilizzano l'endpoint regionale us-south. Per visualizzare ulteriori endpoint API, consulta Virtual Private Cloud API.

Passo 1: Memorizza la tua chiave API come una variabile

Esegui questo comando per memorizzare la chiave API per il tuo account in una variabile di ambiente. Se non hai una chiave API, vedi Creazione di una chiave API.

apikey="<YOUR_API_KEY>"

Passo 2: ottieni un token IBM IAM (Identity and Access Management)

Esegui il seguente comando per recuperare e analizzare un token IAM utilizzando l'utilità di elaborazione JSON jq. Puoi modificare il comando per utilizzare un altro strumento di analisi oppure puoi rimuovere l'ultima parte del comando se preferisci analizzare manualmente il token.

iam_token=`curl -k -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Accept: application/json" \
  --data-urlencode "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  --data-urlencode "apikey=$apikey" \
  "https://iam.cloud.ibm.com/identity/token"  |jq -r '(.token_type + " " + .access_token)'`

Per visualizzare il token IAM, esegui il comando echo $iam_token. Il risultato dovrebbe essere simile a questo:

Bearer <your token>

L'intestazione dell'autorizzazione prevede che il token inizi con "Bearer". Se il risultato non include "Bearer", aggiorna la variabile iam_token per includerlo. In questi esempi si presuppone che "Bearer" sia incluso in iam_token.

Poiché il token scade, devi ripetere il passo precedente per aggiornare il token IAM ogni ora.

Passo 3: Memorizza l'endpoint API come una variabile

Esegui questo comando per memorizzare l'endpoint API in una variabile in modo che possa essere riutilizzato successivamente nella tua sessione.

Endpoint pubblico:

vpc_api_endpoint="https://us-south.iaas.cloud.ibm.com"

Endpoint privato virtuale:

vpc_api_endpoint="https://us-south.private.iaas.cloud.ibm.com"

Per verificare che questa variabile sia stata salvata, esegui il comando ``echo $vpc_api_endpoint`` e assicurati che la risposta non sia vuota.

Per le regioni endpoint supportate, consultare Endpoint disponibili.

Passo 4: Memorizza la versione API come una variabile

Ogni richiesta API deve includere il parametro version, nel formato YYYY-MM-DD. Immetti il seguente comando per memorizzare la data della versione in una variabile in modo che possa essere riutilizzata nella tua sessione. Per ulteriori informazioni sull'impostazione del parametro " version ", consultare la pagina Gestione delle versioni nella guida " API del cloud privato virtuale".

api_version="2019-09-30"

Per verificare che questa variabile sia stata salvata, esegui il comando ``echo $api_version`` e assicurati che la risposta non sia vuota.

Passo 5: Verifica di disporre dell'accesso API

Se riscontri dei risultati imprevisti, aggiungi l'indicatore --verbose (debug) dopo il comando curl per ottenere informazioni di registrazione dettagliate. Per ulteriori informazioni sugli errori comunemente riscontrati, vedi Risoluzione dei problemi.

Richiama l'API GET Regions per visualizzare le regioni disponibili per VPC, in formato JSON. Deve essere restituito almeno un oggetto.

Devi inviare il parametro generation con ogni richiesta API per specificare quale generazione utilizzare. Per le VSI (virtual server instance) di generazione 2, specifica generation=2. Per ulteriori informazioni, consultare la guida " Generazione " (Guida alla gestione delle risorse) all'indirizzo API del cloud privato virtuale.
```
curl -X GET "$vpc_api_endpoint/v1/regions?version=$api_version&generation=2" \
  -H "Authorization: Bearer $iam_token"
```
Richiama l'API GET Zones per visualizzare tutte le zone disponibili per VPC in una specifica regione, come ad esempio us-south, in formato JSON.
```
curl -X GET "$vpc_api_endpoint/v1/regions/us-south/zones?version=$api_version&generation=2" \
  -H "Authorization: Bearer $iam_token"
```
Richiama l'API GET Profiles per visualizzare i profili disponibili per le tue VSI (virtual server instance), in formato JSON. Deve essere restituito almeno un oggetto.

Aggiungi | json_pp dopo il comando curl per ottenere una stringa JSON leggibile. Il comando json_pp è un preprocessore JSON che di solito è installato in modo predefinito sulla maggior parte delle distribuzioni Linux.
```
curl -X GET "$vpc_api_endpoint/v1/instance/profiles?version=$api_version&generation=2" \
  -H "Authorization: Bearer $iam_token"
```
Richiama l'API GET Images per restituire le immagini disponibili per le tue istanze, in formato JSON. Deve essere restituito almeno un oggetto.
```
curl -X GET "$vpc_api_endpoint/v1/images?version=$api_version&generation=2" \
  -H "Authorization: Bearer $iam_token"
```

Richiama l'API GET VPCs per visualizzare i VPC che erano già stati creati nel tuo account, in formato JSON.

curl -X GET "$vpc_api_endpoint/v1/vpcs?version=$api_version&generation=2" \
  -H "Authorization: Bearer $iam_token"

Per informazioni su come creare le risorse utilizzando l'API, vedi Creazione di risorse VPC con CLI e API.