Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Grundlegende betriebliche Eigenschaften

11/11/2024 Beitragende

PDFs

IM RUHEZUSTAND werden einheitliche Technologien und Best Practices erstellt, jedoch können die Details jeder API je nach dem verfügbaren Design variieren. Vor der Verwendung der API sollten Sie auf die Details und betrieblichen Merkmale der ONTAP Select Deploy-API achten.

Hypervisor-Host oder ONTAP Select-Node

Ein Hypervisor-Host ist die zentrale Hardware-Plattform, die eine ONTAP Select Virtual Machine hostet. Wenn eine ONTAP Select Virtual Machine auf einem Hypervisor-Host bereitgestellt und aktiv ist, gilt die Virtual Machine als „ONTAP Select Node“. Ab Version 3 der Deploy REST API sind Host- und Node-Objekte voneinander getrennt und unterscheiden sich. Dadurch wird eine 1:n-Beziehung möglich, bei der ein oder mehrere ONTAP Select Nodes auf demselben Hypervisor-Host ausgeführt werden können.

Objektkennungen

Jeder Ressourceninstanz oder jedem Objekt wird eine eindeutige Kennung zugewiesen, wenn sie erstellt wird. Diese Kennungen sind global eindeutig in einer bestimmten Instanz von ONTAP Select Deploy. Nach der Ausgabe eines API-Aufrufs, der eine neue Objektinstanz erstellt, wird der zugehörige id-Wert an den Anrufer im Header der HTTP-Antwort zurückgegeben location. Sie können die Kennung extrahieren und bei nachfolgenden Anrufen verwenden, wenn Sie sich auf die Ressourceninstanz beziehen.

Der Inhalt und die interne Struktur der Objektkennungen können jederzeit geändert werden. Wenn Sie auf die zugeordneten Objekte verweisen, sollten Sie die Kennungen für die entsprechenden API-Aufrufe nur nach Bedarf verwenden.

Identifikatoren anfordern

Jeder erfolgreichen API-Anforderung wird eine eindeutige Kennung zugewiesen. Der Bezeichner wird im Header der zugehörigen HTTP-Antwort zurückgegeben request-id. Sie können eine Anforderungskennung verwenden, um sich kollektiv auf die Aktivitäten einer einzelnen spezifischen API-Anforderungstransaktion zu beziehen. Sie können beispielsweise alle Ereignismeldungen einer Transaktion basierend auf der Anfrage-ID abrufen

Synchrone und asynchrone Anrufe

Es gibt zwei primäre Möglichkeiten, wie ein Server eine von einem Client empfangene HTTP-Anfrage durchführt:

Synchron der Server führt die Anforderung sofort aus und antwortet mit einem Statuscode von 200, 201 oder 204.
Asynchronous der Server akzeptiert die Anfrage und antwortet mit einem Statuscode von 202. Dies zeigt an, dass der Server die Clientanforderung angenommen hat und eine Hintergrundaufgabe gestartet hat, um die Anforderung abzuschließen. Der endgültige Erfolg oder Fehler ist nicht sofort verfügbar und muss durch zusätzliche API-Aufrufe ermittelt werden.

Bestätigen Sie den Abschluss eines lang laufenden Jobs

Im Allgemeinen wird jeder Vorgang, der viel Zeit in Anspruch nehmen kann, asynchron mittels einer Hintergrundaufgabe am Server verarbeitet. Mit DER REST-API „Bereitstellen“ wird jede Hintergrundaufgabe durch ein Jobobjekt verankert, das die Aufgabe verfolgt und Informationen liefert, z. B. den aktuellen Status. Ein Job-Objekt, einschließlich seiner eindeutigen Kennung, wird in der HTTP-Antwort zurückgegeben, nachdem eine Hintergrundaufgabe erstellt wurde.

Sie können das Jobobjekt direkt abfragen, um den Erfolg oder den Fehler des zugeordneten API-Aufrufs zu ermitteln. Weitere Informationen finden Sie unter „Asynchronous Processing Using the Job Object“.

Neben der Verwendung des Jobobjekts gibt es noch weitere Möglichkeiten, wie Sie den Erfolg oder den Fehler einer Anfrage bestimmen können, darunter:

Ereignismeldungen Sie können alle Ereignismeldungen abrufen, die mit einem bestimmten API-Aufruf verknüpft sind. Verwenden Sie dazu die Anforderung-id, die mit der ursprünglichen Antwort zurückgegeben wurde. Die Ereignismeldungen enthalten in der Regel Hinweise auf Erfolg oder Fehler und können auch nützlich sein, wenn ein Fehlerzustand behoben wird.
Ressourcenstatus oder -Status mehrere der Ressourcen verwalten einen Zustand- oder Statuswert, den Sie abfragen können, um den Erfolg oder Fehler einer Anfrage indirekt zu bestimmen.

Sicherheit

Die Deploy-API nutzt die folgenden Sicherheitstechnologien:

Transportschichtsicherheit der gesamte über das Netzwerk zwischen dem Bereitstellungsserver und dem Client gesendete Datenverkehr wird über TLS verschlüsselt. Die Verwendung des HTTP-Protokolls über einen unverschlüsselten Kanal wird nicht unterstützt. TLS-Version 1.2 wird unterstützt.
HTTP-Authentifizierung die grundlegende Authentifizierung wird für jede API-Transaktion verwendet. Jeder Anforderung wird ein HTTP-Header hinzugefügt, der den Benutzernamen und das Passwort in einem base64-String enthält.