Wie verwende ich FSx für ONTAP REST-APIs?

Letzte Aktualisierung: 14.11.2022

Ich möchte die NetApp ONTAP REST API verwenden, um meine Amazon-FSx-for-NetApp-ONTAP-Ressourcen zu verwalten. Wie mache ich das?

Auflösung

Voraussetzungen

Der API-Anforderer muss in der Lage sein, HTTPS-Verbindungen zum FSx-for-ONTAP-Dateisystem und zu den Endpunkten der virtuellen Speichermaschine (SVM) herzustellen. Weitere Informationen finden Sie unter Verwenden der NetApp-ONTAP-REST-API.

Hello World auf dem FSx for ONTAP-Dateisystem mit curl ausführen

Gehen Sie an der Befehlszeilenschnittstelle einer Linux-Instance auf Ihrer Amazon Virtual Private Cloud (Amazon VPC), auf der das FSx-for-ONTAP-Dateisystem ausgeführt wird, wie folgt vor:

1.    Geben Sie Ihr fsxadmin-Passwort und den Endpunkt-DNS-Namen ein. Ersetzen Sie im folgenden Beispielbefehl Passwort und fs-XXXXXXXX.fsx.region.amazonaws.com durch die richtigen Werte für Ihren Anwendungsfall:

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

2.    Führen Sie den folgenden Befehl aus, um die ONTAP-Softwareversion abzurufen:

$ 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"
    }
  }
}

Beispiel für eine REST-API: Volumen abrufen

Im Folgenden finden Sie ein Beispiel für den GET-Befehl, der zum Abrufen von Volumes verwendet wird:

$ 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"
    }
  }
}

Hinweis: Einige APIs laufen nicht auf FSx for ONTAP.

Verwenden Sie die NetApp-BlueXP-API-Swagger-Schnittstelle

Sie können über die BlueXP-r-Connector-Swagger-Schnittstelle auf einige NetApp ONTAP APIs zugreifen. Weitere Informationen finden Sie unter Mehr über BlueXP erfahren und So melden Sie sich bei der API-Swagger-Schnittstelle von BlueXP (ehemals Cloud Manager) auf der NetApp-Website an.

Die folgenden Schritte sind ein Beispiel für den Zugriff auf die Swagger-Schnittstelle mit BlueXP und das Posten von Anmeldeinformationen.

1.    Wählen Sie im BlueXP Connector das Hilfemenü, dargestellt durch ein Fragezeichen, und wählen Sie dann API aus.

Oder gehen Sie direkt zur Swagger-Oberfläche (Beispiel-URL: http://connectorip/occm/api-doc/).

2.    Wählen Sie Benutzerverwaltungsvorgänge aus.

3.    Wählen Sie auth: Authentifizierungsoperationen aus.

4.    Wählen Sie POST /auth/login, Expand Operations aus.

5.    Wählen Sie Modellschema aus.

6.    Wählen Sie Klicken, um einen Parameterwert unter dem Modellschema festzulegen, das Folgendes anzeigt:

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

7.    Bearbeiten Sie im Feld Wert, in das das Modellschema gefüllt ist, die Zeichenfolge, um Ihre korrekte E-Mail-Adresse und Ihr Passwort anzugeben:

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

Hinweis: Die E-Mail-ID ist nicht fsxadmin. Die E-Mail ist die Cloud-Central-Auth0-E-Mail-ID, mit der Sie sich beim BlueXP Connector anmelden. Das Passwort ist im Klartext festgelegt.

8.    Wählen Sie Jetzt testen!

9.    Stellen Sie anhand des Antwortcodes sicher, dass die Anmeldung erfolgreich war.

Beispiel: Holen Sie sich die Volumes-API mit der BlueXP-Swagger-Schnittstelle

1.    Wählen Sie in der Swagger-Oberfläche die Option FSx (Data ONTAP Cluster) Arbeitsumgebungsoperationen aus.

2.    Wählen Sie fsx/volumes aus.

3.    Wählen Sie GET /fsx/volumes, Expand Operations aus.

4.    Geben Sie im Feld Wert die Dateisystem-ID ein, von der Sie die Volumenliste abrufen möchten.

5.    Wählen Sie Jetzt testen!

6.    Stellen Sie anhand des Antwortcodes und des Antworttextes sicher, dass die Anmeldung erfolgreich war.


War dieser Artikel hilfreich?


Benötigen Sie Hilfe zur Fakturierung oder technischen Support?