Comment utiliser FSx pour les API REST ONTAP ?

Date de la dernière mise à jour : 14/11/2022

Je souhaite utiliser l'API REST NetApp ONTAP pour gérer mes ressources Amazon FSx pour NetApp ONTAP. Comment procéder ?

Solution

Conditions préalables

Le demandeur d'API doit être en mesure d'établir des connexions HTTPS au système de fichiers FSx for ONTAP et aux points de terminaison de la machine virtuelle de stockage (SVM). Pour plus d'informations, consultez la section Utilisation de l'API REST NetApp ONTAP.

Exécutez Hello World sur le système de fichiers FSx pour ONTAP avec curl

Sur l'interface de ligne de commande d'une instance Linux sur votre Amazon Virtual Private Cloud (Amazon VPC) exécutant le système de fichiers FSx for ONTAP, procédez comme suit :

1.    Entrez votre mot de passe fsxadmin et le nom DNS du point de terminaison. Dans l'exemple de commande suivant, remplacez Password et fs-XXXXXXXX.fsx.region.amazonaws.com par les valeurs adaptées à votre cas d'utilisation :

$ CRED=fsxadmin:Password
$ ONTAP=management.fs-XXXXXXXX.fsx.region.amazonaws.com

2.    Exécutez la commande suivante pour récupérer la version du logiciel ONTAP :

$ curl -X GET -u ${CRED} -k "https://${ONTAP}/api/cluster?fields=version"
{
  "version": {
    "full": "NetApp Release 9.10.1RC1P1: Sat Nov 27 18:08:32 UTC 2021",
    "generation": 9,
    "major": 10,
    "minor": 1
  },
  "_links": {
    "self": {
      "href": "/api/cluster"
    }
  }
}

Exemple d'API REST : Obtenir des volumes

Voici un exemple de la commande GET utilisée pour récupérer des volumes :

$ curl -X GET -u ${CRED} -k "https://${ONTAP}/api/storage/volumes"
{
  "records": [
    {
      "uuid": "504c8162-a435-11ec-bb13-130f21c56a08",
      "name": "svm1_root",
      "_links": {
        "self": {
          "href": "/api/storage/volumes/504c8162-a435-11ec-bb13-130f21c56a08"
        }
      }
    },
    {
      "uuid": "956f5ce9-a435-11ec-bb13-130f21c56a08",
      "name": "vol1",
      "_links": {
        "self": {
          "href": "/api/storage/volumes/956f5ce9-a435-11ec-bb13-130f21c56a08"
        }
      }
    }
  ],
  "num_records": 2,
  "_links": {
    "self": {
      "href": "/api/storage/volumes"
    }
  }
}

Remarque : certaines API ne s'exécutent pas sur FSx pour ONTAP.

Utiliser l'interface Swagger de l'API NetApp BlueXP

Vous pouvez accéder à certaines API NetApp ONTAP à l'aide de l'interface BlueXP ou Connector Swagger. Pour plus d'informations, consultez la section En savoir plus sur BlueXP et Comment se connecter à l'interface Swagger de l'API BlueXP (anciennement Cloud Manager) sur le site Web de NetApp.

Les étapes suivantes constituent un exemple d'accès à l'interface Swagger à l'aide de BlueXP et de publication d'informations d'identification.

1.    Dans le connecteur BlueXP, sélectionnez le menu Help (Aide), représenté par un point d'interrogation, puis sélectionnez API.

Vous pouvez également accéder directement à l'interface Swagger (exemple d'URL : http://connectorip/occm/api-doc/).

2.    Sélectionnez User Management Operations (Opérations de gestion des utilisateurs).

3.    Sélectionnez auth : Authentication operations(auth : Authentication operations).

4.    Sélectionnez POST /auth/login, puis Expand Operations (Développer les opérations).

5.    SélectionnezModel Schema (Schéma du modèle).

6.    Sélectionnez Click to set as parameter value (Cliquez pour définir comme valeur de paramètre) dans le schéma du modèle qui affiche les informations suivantes :

{
"email": "string",
"password": "string"
}

7.    Dans le champ Value (Valeur) où le schéma du modèle est renseigné, modifiez la chaîne pour fournir votre adresse e-mail et votre mot de passe corrects :

{
"email": "user@example.com",
"password": "xxxxxxxxxx"
}

Remarque : L'adresse e-mail n'est pas fsxadmin. L'e-mail est Cloud Central Auth0 email id utilisé pour se connecter au BlueXP Connector. Le mot de passe est défini en texte brut.

8.    Sélectionnez Try it out! (Essayez-le !)

9.    Vérifiez que la connexion est réussie à partir du Code de réponse.

Exemple : API Get Volumes à l'aide de l'interface BlueXP Swagger

1.    Dans l'interface Swagger, sélectionnez FSx (Data ONTAP cluster) working environment operations (Opérations de l'environnement de travail FSx (Data ONTAP cluster)).

2.    Sélectionnez fsx/volumes.

3.    Sélectionnez GET /fsx/volumes, Développer les opérations.

4.    Dans le champ Valeur, entrez l'ID du système de fichiers à partir duquel vous souhaitez récupérer la liste des volumes.

5.    Sélectionnez Try it out! (Essayez-le !)

6.    Vérifiez que la connexion est réussie à partir du Code de réponse et du Corps de réponse.


Cet article vous a-t-il été utile ?


Besoin d'aide pour une question technique ou de facturation ?