Caratteristiche operative di base
Suggerisci modifiche
PDF
Mentre REST stabilisce un insieme comune di tecnologie e Best practice, i dettagli di ciascuna API possono variare in base alle scelte di progettazione. Prima di utilizzare l'API, è necessario conoscere i dettagli e le caratteristiche operative dell'API di implementazione di ONTAP Select.
Host hypervisor rispetto al nodo ONTAP Select
Un host hypervisor è la piattaforma hardware principale che ospita una macchina virtuale ONTAP Select. Quando una macchina virtuale ONTAP Select viene implementata e attiva su un host hypervisor, la macchina virtuale viene considerata un nodo ONTAP Select. Con la versione 3 dell'API REST di implementazione, gli oggetti host e nodo sono separati e distinti. Ciò consente una relazione uno-a-molti, in cui uno o più nodi ONTAP Select possono essere eseguiti sullo stesso host hypervisor.
Identificatori di oggetti
A ogni istanza o oggetto di risorsa viene assegnato un identificatore univoco al momento della creazione. Questi identificatori sono univoci a livello globale all'interno di una specifica istanza di ONTAP Select Deploy. Dopo aver eseguito una chiamata API che crea una nuova istanza di oggetto, il valore id associato viene restituito al chiamante in location Intestazione della risposta HTTP. È possibile estrarre l'identificatore e utilizzarlo nelle chiamate successive quando si fa riferimento all'istanza della risorsa.
|
Il contenuto e la struttura interna degli identificatori di oggetti possono cambiare in qualsiasi momento. È necessario utilizzare gli identificatori delle chiamate API applicabili solo se necessario quando si fa riferimento agli oggetti associati. |
Richiedi identificatori
A ogni richiesta API riuscita viene assegnato un identificatore univoco. L'identificatore viene restituito in request-id Intestazione della risposta HTTP associata. È possibile utilizzare un identificatore di richiesta per fare riferimento collettivamente alle attività di una singola transazione richiesta-risposta API specifica. Ad esempio, è possibile recuperare tutti i messaggi di evento per una transazione in base all'ID della richiesta.
Chiamate sincrone e asincrone
Esistono due modi principali in cui un server esegue una richiesta HTTP ricevuta da un client:
-
Sincrono
Il server esegue immediatamente la richiesta e risponde con un codice di stato 200, 201 o 204. -
Asincrono
Il server accetta la richiesta e risponde con un codice di stato 202. Indica che il server ha accettato la richiesta del client e ha avviato un'attività in background per completare la richiesta. Il successo o l'errore finale non sono immediatamente disponibili e devono essere determinati tramite chiamate API aggiuntive.
Confermare il completamento di un lavoro a esecuzione prolungata
Generalmente, qualsiasi operazione che può richiedere molto tempo per essere completata viene elaborata in modo asincrono utilizzando un
attività in background sul server. Con l'API REST di distribuzione, ogni attività in background è ancorata da un
Oggetto lavoro che tiene traccia dell'attività e fornisce informazioni, ad esempio lo stato corrente. Un oggetto lavoro,
Dopo la creazione di un'attività in background, nella risposta HTTP viene restituito il relativo identificatore univoco.
È possibile eseguire query direttamente sull'oggetto Job per determinare il successo o l'errore della chiamata API associata.
Per ulteriori informazioni, fare riferimento a elaborazione asincrona mediante l'oggetto Job.
Oltre a utilizzare l'oggetto lavoro, esistono altri modi per determinare il successo o il fallimento di un
richieste che includono:
-
Messaggi di evento
È possibile recuperare tutti i messaggi di evento associati a una specifica chiamata API utilizzando l'id richiesta restituito con la risposta originale. I messaggi di evento contengono in genere un'indicazione di successo o di errore e possono essere utili anche quando si esegue il debug di una condizione di errore. -
Stato o stato della risorsa
Diverse risorse mantengono un valore di stato o stato che è possibile eseguire query per determinare indirettamente il successo o il fallimento di una richiesta.
Sicurezza
L'API di implementazione utilizza le seguenti tecnologie di sicurezza:
-
Transport Layer Security
Tutto il traffico inviato sulla rete tra il server di distribuzione e il client viene crittografato tramite TLS. L'utilizzo del protocollo HTTP su un canale non crittografato non è supportato. È supportata la versione TLS 1.2. -
Autenticazione HTTP
L'autenticazione di base viene utilizzata per ogni transazione API. A ogni richiesta viene aggiunta un'intestazione HTTP, che include il nome utente e la password in una stringa base64.