Etape 1 : stockez votre clé d'API sous forme de variable

Exécutez la commande suivante pour stocker la clé d'API pour votre compte dans une variable d'environnement. Si vous n'avez pas de clé d'API, voir Création d'une clé d'API.

apikey="<YOUR_API_KEY>"

Etape 2 : obtenez un jeton IBM IAM (Identity and Access Management)

Exécutez la commande suivante pour récupérer et analyser un jeton IAM à l'aide de l'utilitaire de traitement JSON jq. Vous pouvez modifier la commande pour utiliser un autre outil d'analyse syntaxique ou supprimer la dernière partie de la commande si vous préférez analyser manuellement le jeton.

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)'`

Pour afficher le jeton IAM, exécutez echo $IAM_TOKEN. Le résultat se présente comme suit :

Bearer <your_token>

L'en-tête d'autorisation s'attend à ce que le jeton commence par Bearer. Si le résultat n'inclut pas Bearer, mettez à jour la variable iam_token pour l'inclure. Ces exemples supposent que Bearer est inclus dans le jeton IAM (IAM_TOKEN).

Étant donné que le jeton IAM expire, vous devez répéter l'étape précédente pour actualiser votre jeton toutes les heures.

Etape 3 : stockez le point d'extrémité d'API en tant que variable

Exécutez la commande suivante pour stocker le nœud final d'API dans une variable afin qu'elle puisse être réutilisée ultérieurement dans votre session.

Nœud final public :

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

Nœud final privé virtuel :

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

Pour vérifier que la variable a bien été enregistrée, exécutez echo $directlink_api_endpoint et assurez-vous que la réponse n'est pas vide.

Etape 4 : stockez la version de l'API en tant que variable

Chaque requête API doit inclure le paramètre version au format YYYY-MM-DD. Exécutez la commande suivante pour enregistrer la date de version dans une variable afin de pouvoir la réutiliser dans votre session. Pour plus d’informations sur la configuration du paramètre version, consultez la section Gestion des versions dans l’API Direct Link.

api_version="2020-03-31"

Pour vérifier que cette variable a été sauvegardée, exécutez echo $api_version et assurez-vous que la réponse n'est pas vide.

Etape 5 : vérifiez que vous disposez d'un accès à l'API

Si vous rencontrez des résultats inattendus, ajoutez l'indicateur --verbose (debug) après la commande curl pour obtenir des informations de journalisation détaillées.

• Appelez l'API List Available Locations pour afficher les emplacements disponibles pour votre lien direct, au format JSON. Au moins un objet est renvoyé.

  Cet exemple répertorie les emplacements disponibles pour une passerelle Direct Link Dedicated. Pour Direct Link Connect, remplacer connect par dedicated.

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

• Appelez l'API List gateways pour afficher, au format JSON, tous les liens directs que vous avez déjà créés sous votre compte.

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