Erfahren Sie mehr über die Speicherverwaltung mit der Element API.
Änderungen vorschlagen
PDFs
Die Element-API basiert auf dem JSON-RPC-Protokoll über HTTPS. JSON-RPC ist ein einfaches textbasiertes RPC-Protokoll, das auf dem schlanken JSON-Datenwechselformat basiert. Client-Bibliotheken sind für alle wichtigen Programmiersprachen verfügbar.
API-Anforderungen können über HTTPS-POSTANFORDERUNGEN an den API-Endpunkt gestellt werden. Der Text der POST-Anforderung ist ein JSON-RPC Request-Objekt. Derzeit unterstützt die API keine Batchanforderungen (mehrere Anforderungsobjekte in einem EINZELNEN POST). Beim Senden von API-Anforderungen müssen Sie „Application/json-rpc“ als Inhaltstyp der Anfrage verwenden und sicherstellen, dass der Körper nicht formcodiert ist.
|
Die Element Web-UI nutzt die in diesem Dokument beschriebenen API-Methoden. Sie können API-Vorgänge in der Benutzeroberfläche überwachen, indem Sie das API-Protokoll aktivieren. Dadurch können Sie die Methoden anzeigen, die an das System ausgegeben werden. Sie können sowohl Anfragen als auch Antworten aktivieren, um zu sehen, wie das System auf die ausgestellten Methoden antwortet. |
Sofern nicht anders angegeben, gelten alle Datumstrings in den API-Antworten im UTC+0-Format.
|
|
Wenn der Storage-Cluster stark ausgelastet ist oder Sie zahlreiche aufeinander folgende API-Anfragen ohne dazwischenende Verzögerungen senden, schlägt die Methode unter Umständen fehl und gibt den Fehler „xDBVersionMismatch“ zurück. In diesem Fall wiederholen Sie den Methodenaufruf. |
Gemeinsame Objekte
Die API der Element Software verwendet JSON-Objekte, um organisierte Datenkonzepte darzustellen. Viele dieser API-Methoden nutzen diese Objekte für die Dateneingabe und -Ausgabe. Dieser Abschnitt dokumentiert diese häufig verwendeten Objekte; Objekte, die nur in einer einzigen Methode verwendet werden, werden mit dieser Methode anstelle von in diesem Abschnitt dokumentiert.
Gängige Methoden
Häufig verwendete Methoden sind Methoden zum Abrufen von Informationen über das Storage-Cluster, die API selbst oder fortlaufende API-Vorgänge.
Account-API-Methoden
Mit Kontomethoden können Sie Konto- und Sicherheitsinformationen hinzufügen, entfernen, anzeigen und ändern.
Administrator-API-Methoden
Mithilfe von Administrator-API-Methoden können Storage-Cluster-Administratoren Storage-Cluster-Administratoren erstellen, ändern, anzeigen und entfernen sowie Zugriffsebenen und Berechtigungen für Benutzer mit Zugriff auf ein Storage-Cluster zuweisen.
Cluster-API-Methoden
Mithilfe der Cluster-API-Methoden der Element Software können Sie die Konfiguration und Topologie des Storage-Clusters und der Nodes, die zu einem Storage-Cluster gehören, managen.
Einige Cluster-API-Methoden werden auf Nodes ausgeführt, die Teil eines Clusters sind oder für die Verbindung zu einem Cluster konfiguriert wurden. Sie können einem neuen Cluster oder einem vorhandenen Cluster Nodes hinzufügen. Nodes, die zu einem Cluster hinzugefügt werden können, befinden sich in einem „ausstehend“, was bedeutet, dass sie konfiguriert, jedoch noch nicht dem Cluster hinzugefügt wurden.
API-Methoden zur Clustererstellung
Sie können diese API-Methoden verwenden, um ein Storage-Cluster zu erstellen. Alle diese Methoden müssen auf einem einzelnen Node gegen den API-Endpunkt eingesetzt werden.
Drive-API-Methoden
Mit den Drive-API-Methoden können Laufwerke hinzugefügt und gemanagt werden, die einem Storage-Cluster zur Verfügung stehen. Wenn Sie dem Storage-Cluster einen Storage-Node hinzufügen oder neue Laufwerke in einem vorhandenen Storage-Node installieren, können die Laufwerke dem Storage-Cluster hinzugefügt werden.
Fibre Channel-API-Methoden
Fibre Channel-API-Methoden können zum Hinzufügen, Ändern oder Entfernen von Fibre Channel-Node-Mitgliedern eines Storage-Clusters verwendet werden.
Initiator-API-Methoden
Mithilfe von Initiator-Methoden können Sie iSCSI-Initiator-Objekte hinzufügen, entfernen, anzeigen und ändern, die die Kommunikation zwischen dem Speichersystem und externen Speicher-Clients behandeln.
LDAP-API-Methoden
Sie können das Lightweight Directory Access Protocol (LDAP) verwenden, um den Zugriff auf Element Storage zu authentifizieren. Mit den in diesem Abschnitt beschriebenen LDAP-API-Methoden können Sie den LDAP-Zugriff auf das Storage-Cluster konfigurieren.
Multi-Faktor-Authentifizierungs-API-Methoden
Sie können Multi-Faktor-Authentifizierung (MFA) verwenden, um Benutzersitzungen über einen Drittanbieter-Identitätsanbieter (IdP) über die Security Assertion Markup Language (SAML) zu verwalten.
API-Methoden für die Sitzungsauthentifizierung
Sie können die sitzungsbasierte Authentifizierung verwenden, um Benutzersitzungen zu verwalten.
Node-API-Methoden
Sie können Node-API-Methoden verwenden, um einzelne Nodes zu konfigurieren. Diese Methoden arbeiten auf einzelnen Nodes, die konfiguriert werden müssen, konfiguriert sind, aber noch nicht an einem Cluster beteiligt sind oder aktiv an einem Cluster teilnehmen. Mithilfe von Node-API-Methoden können Sie Einstellungen für einzelne Nodes und das Cluster-Netzwerk, das zur Kommunikation mit dem Node verwendet wird, anzeigen und ändern. Sie müssen diese Methoden für einzelne Nodes ausführen. Sie können keine API-Methoden pro Node für die Adresse des Clusters ausführen.
Replizierungs-API-Methoden
Mit den Replication-API-Methoden können Sie zwei Cluster verbinden, um einen kontinuierlichen Datenschutz (CDP) zu ermöglichen. Wenn Sie zwei Cluster verbinden, können aktive Volumes innerhalb eines Clusters kontinuierlich auf ein zweites Cluster repliziert werden, um eine Datenwiederherstellung bereitzustellen. Durch das Pairing von Volumes zur Replikation können Sie Ihre Daten vor Ereignissen schützen, die den Zugriff auf diese Dateien möglicherweise nicht ermöglichen.
Sicherheits-API-Methoden
Sie können Element Software in externe, sicherheitsbezogene Services wie einen externen Verschlüsselungsmanagementserver integrieren. Mit diesen sicherheitsbezogenen Methoden können Sie Sicherheitsfunktionen für Komponenten wie externes Verschlüsselungsmanagement für die Verschlüsselung im Ruhezustand konfigurieren.
SnapMirror API-Methoden
Die SnapMirror API-Methoden werden von der Element Web-Benutzeroberfläche zum Management von Snapshots verwendet, die mit Remote-ONTAP-Systemen gespiegelt wurden. Diese Methoden sind nur für die Verwendung durch Element Web UI gedacht. Wenn Sie API-Zugriff auf die SnapMirror-Funktion benötigen, verwenden Sie die ONTAP-APIs. Beispiele für Anfragen und Rückgabeverfahren werden nicht für SnapMirror API-Methoden zur Verfügung gestellt.
Methoden für die Systemkonfiguration-API
Mit Systemkonfigurations-API-Methoden können Sie Konfigurationswerte abrufen und festlegen, die für alle Knoten im Cluster gelten.
Mandantenfähige Netzwerk-API-Methoden
Das mandantenfähige Netzwerk in Element Storage-Clustern ermöglicht den Datenverkehr zwischen mehreren Clients, die sich in separaten logischen Netzwerken befinden, ohne Layer-3-Routing mit einem Element Storage-Cluster verbunden werden.
Verbindungen zum Storage-Cluster sind im Netzwerk-Stack durch VLAN-Tagging getrennt.
Voraussetzungen für die Einrichtung eines mandantenfähigen virtuellen Netzwerks
-
Sie müssen den Block der Client-Netzwerk-IP-Adressen identifiziert haben, die den virtuellen Netzwerken auf den Storage-Nodes zugewiesen werden sollen.
-
Sie müssen eine SVIP-Adresse (Client Storage Network IP) für den gesamten Storage-Datenverkehr als Endpunkt angegeben haben.
Reihenfolge der Vorgänge virtueller Netzwerke
-
Verwenden Sie die AddVirtualNetwork-Methode, um die IP-Adressen, die Sie eingeben, in Massen bereitzustellen.
Nachdem Sie ein virtuelles Netzwerk hinzugefügt haben, führt der Cluster automatisch die folgenden Schritte aus:
-
Jeder Storage-Node erstellt eine virtuelle Netzwerkschnittstelle.
-
Jedem Speicherknoten wird eine VLAN-Adresse zugewiesen, die über das virtuelle SVIP weitergeleitet werden kann.
-
Bei einem Neubooten eines Node bleiben VLAN-IP-Adressen auf jedem Node erhalten.
-
-
Wenn die virtuelle Netzwerkschnittstelle und die VLAN-Adressen zugewiesen wurden, können Sie dem virtuellen SVIP Client-Netzwerkverkehr zuweisen.
Volume-API-Methoden
Mit Element Software für die Volume-API-Methoden können Sie Volumes managen, die sich auf einem Storage-Node befinden. Mit diesen Methoden können Sie Volumes erstellen, ändern, klonen und löschen. Sie können auch Volume-API-Methoden verwenden, um Datenmessungen für ein Volume zu erfassen und anzuzeigen.
API-Methoden für Volume-Zugriffsgruppen
Mit Methoden für Volume-Zugriffsgruppen können Sie Volume-Zugriffsgruppen hinzufügen, entfernen, anzeigen und ändern. Dabei handelt es sich um Sammlungen von Volumes, auf die Benutzer über iSCSI- oder Fibre-Channel-Initiatoren zugreifen können.
Volume Snapshot-API-Methoden
Mit Element Software Volume Snapshot-API-Methoden können Sie Volume-Snapshots verwalten. Mithilfe der API-Methoden für den Volume-Snapshot können Volume-Snapshots erstellt, geändert, geklont und gelöscht werden.
API-Methoden für virtuelle Volumes
Mit Element Software können Sie Virtual Volume API-Methoden (VVols) managen. Vorhandene VVols können mit diesen API-Methoden angezeigt werden sowie Storage Container für virtuelle Volumes erstellen, ändern und löschen. Obwohl Sie diese Methoden nicht zum Betrieb auf normalen Volumes verwenden können, können Sie die normalen Volume-API-Methoden verwenden, um Informationen über VVols aufzulisten.