Configurazione dell'ambiente API

Prima di poter utilizzare l'API Direct Link, è necessario configurare l'ambiente.

Prerequisiti generali

Imposta il tuo account per accedere al link diretto. Assicurati che il tuo account sia stato aggiornato a un account a pagamento.

Prerequisiti API

Prima di poter utilizzare l'API per interagire con un collegamento diretto, devi ottenere un token IAM e archiviare l'endpoint come variabile. Verificare anche che si abbia accesso al servizio IBM Cloud Direct Link API.

I seguenti esempi utilizzano l'endpoint globale directlink.cloud.ibm.com.

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, eseguire il comando echo $IAM_TOKEN. Il risultato è il seguente:

Bearer <your_token>

L'intestazione "Authorization" richiede che il token inizi con Bearer. Se il risultato non include Bearer, aggiorna la variabile iam_token in modo da includerlo. Questi esempi presuppongono che il file Bearer sia incluso nel file IAM_TOKEN``.

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

Passo 3: Memorizza l'endpoint API come una variabile

Esegui il seguente comando per memorizzare l'endpoint dell'API in una variabile, in modo da poterlo riutilizzare in seguito durante la sessione.

Endpoint pubblico:

directlink_api_endpoint="https://directlink.cloud.ibm.com"

Endpoint privato virtuale:

directlink_api_endpoint="https://private.directlink.cloud.ibm.com"

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

Passo 4: Memorizza la versione API come una variabile

Ogni richiesta API deve includere il parametro version nel formato YYYY-MM-DD``. Esegui il seguente comando per memorizzare la data della versione in una variabile, in modo da poterla riutilizzare durante la sessione. Per ulteriori informazioni sull'impostazione del parametro version , consultare la sezione " Gestione delle versioni " nell'API di Direct Link.

api_version="2020-03-31"

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.

Richiama l'API List Available Locations per vedere le ubicazioni disponibili per il tuo direct link, in formato JSON. Almeno un oggetto ritorna.

Questo esempio elenca le posizioni disponibili per un gateway Direct Link Dedicated. Per Direct Link Connect, sostituire connect con dedicated.
```
curl -X GET "$directlink_api_endpoint/v1/offering_types/dedicated/locations?version=$api_version"   -H "Authorization: $IAM_TOKEN"
```

Richiama l'API List gateways per visualizzare i link diretti che hai già creato nel tuo account, in formato JSON.

curl -X GET "$directlink_api_endpoint/v1/gateways?version=$api_version"   -H "Authorization: $IAM_TOKEN"