Le informazioni API più recenti sono reperibili accedendo a Data Infrastructure Insights e andando su Amministrazione > Accesso API. Fare clic sul collegamento Documentazione API.

La documentazione API è basata su Swagger, che fornisce una breve descrizione e informazioni sull'utilizzo dell'API e consente di provarla nel proprio tenant. A seconda del ruolo utente e/o dell'edizione Data Infrastructure Insights , i tipi di API disponibili potrebbero variare.

Prima di utilizzare l'API Data Infrastructure Insights , è necessario creare uno o più token di accesso API. I token di accesso vengono utilizzati per tipi di API specifici e possono concedere autorizzazioni di lettura e/o scrittura. È anche possibile impostare la scadenza per ciascun token di accesso. Tutte le API dei tipi specificati sono valide per il token di accesso. Ogni token è privo di nome utente o password.

Per creare un token di accesso:

È possibile disattivare, attivare e revocare i token. I token disabilitati possono essere abilitati.

I token garantiscono l'accesso generico alle API dal punto di vista del cliente, gestendo l'accesso alle API nell'ambito del proprio tenant. Gli amministratori dei clienti possono concedere e revocare questi token senza il coinvolgimento diretto del personale back-end di Data Infrastructure Insights .

L'applicazione riceve un token di accesso dopo che un utente si è autenticato e ha autorizzato l'accesso, quindi passa il token di accesso come credenziale quando chiama l'API di destinazione. Il token trasmesso informa l'API che il portatore del token è stato autorizzato ad accedere all'API ed eseguire azioni specifiche specificate dall'ambito concesso durante l'autorizzazione.

L'intestazione HTTP in cui viene passato il token di accesso è X-CloudInsights-ApiKey:.

Ad esempio, utilizzare quanto segue per recuperare le risorse di archiviazione:

Consulta le pagine Swagger per esempi specifici per l'API che desideri utilizzare.

L'API Data Infrastructure Insights è basata su categorie e attualmente contiene i seguenti tipi:

Nel tempo potrebbero diventare disponibili altri tipi e/o API. Puoi trovare le informazioni API più recenti in"Documentazione API Swagger" .

Si noti che i tipi di API a cui un utente ha accesso dipendono anche da"Ruolo utente" dispongono in ogni set di funzionalità Data Infrastructure Insights (monitoraggio, sicurezza del carico di lavoro, reporting).

Questa sezione descrive come attraversare una gerarchia di oggetti Data Infrastructure Insights .

Molti comandi API supportano il parametro expand, che fornisce dettagli aggiuntivi sull'oggetto o sugli URL per gli oggetti correlati.

L'unico parametro di espansione comune è expands. La risposta contiene un elenco di tutte le espansioni specifiche disponibili per l'oggetto.

Ad esempio, quando si richiede quanto segue:

Ogni espansione contiene dati, un URL o entrambi. Il parametro expand supporta attributi multipli e annidati, ad esempio:

Per scoraggiare questo fenomeno, le richieste di raccolte di livello superiore non possono essere ampliate. Ad esempio, non è possibile richiedere l'espansione dei dati per tutti gli oggetti di archiviazione contemporaneamente. I client devono recuperare l'elenco degli oggetti e quindi scegliere oggetti specifici da espandere.

I dati sulle prestazioni vengono raccolti su più dispositivi come campioni separati. Ogni ora (impostazione predefinita), Data Infrastructure Insights aggrega e riepiloga i campioni di prestazioni.

L'API consente l'accesso sia ai campioni sia ai dati riepilogati. Per un oggetto con dati sulle prestazioni, un riepilogo delle prestazioni è disponibile come expand=performance. Le serie temporali della cronologia delle prestazioni sono disponibili tramite expand=performance.history annidato.

Esempi di oggetti Performance Data includono:

Una metrica delle prestazioni ha una descrizione e un tipo e contiene una raccolta di riepiloghi delle prestazioni. Ad esempio, Latenza, Traffico e Velocità.

Un riepilogo delle prestazioni contiene una descrizione, un'unità, un orario di inizio e di fine del campione e una raccolta di valori riepilogati (corrente, minimo, massimo, medio, ecc.) calcolati da un singolo contatore delle prestazioni in un intervallo di tempo (1 ora, 24 ore, 3 giorni e così via).

Il dizionario Performance Data risultante ha le seguenti chiavi:

Ogni tipo di oggetto dati sulle prestazioni ha un set univoco di metriche sulle prestazioni. Ad esempio, l'oggetto prestazioni della macchina virtuale supporta "diskThroughput" come metrica delle prestazioni. Ogni metrica delle prestazioni supportata appartiene a una determinata "performanceCategory" presentata nel dizionario delle metriche. Data Infrastructure Insights supporta diversi tipi di metriche delle prestazioni elencati più avanti in questo documento. Ogni dizionario di metriche di prestazione avrà anche il campo "descrizione", che è una descrizione leggibile da un essere umano di questa metrica di prestazione e un set di voci di conteggio riepilogative delle prestazioni.

Il contatore Riepilogo prestazioni è il riepilogo dei contatori delle prestazioni. Presenta valori aggregati tipici come minimo, massimo e medio per un contatore, nonché l'ultimo valore osservato, l'intervallo di tempo per i dati riepilogati, il tipo di unità per il contatore e le soglie per i dati. Solo le soglie sono facoltative; il resto degli attributi è obbligatorio.

Sono disponibili riepiloghi delle prestazioni per questi tipi di contatori:

L'API può restituire metriche dettagliate per gli oggetti nel tuo tenant, ad esempio:

Vedi il"Documentazione API Swagger" per informazioni sulle metriche per ciascun tipo di oggetto.

I dati storici vengono presentati nei dati sulle prestazioni come un elenco di coppie di mappe di timestamp e contatori.

I contatori cronologici vengono denominati in base al nome dell'oggetto metrica delle prestazioni. Ad esempio, l'oggetto prestazioni della macchina virtuale supporta "diskThroughput", quindi la mappa cronologica conterrà chiavi denominate "diskThroughput.read", "diskThroughput.write" e "diskThroughput.total".

Di seguito è riportato un esempio di dati sulle prestazioni JSON per un disco:

Gli oggetti con attributi di capacità utilizzano tipi di dati di base e CapacityItem per la rappresentazione.

L'API di ricerca è un semplice punto di accesso al sistema. L'unico parametro di input per l'API è una stringa in formato libero e il JSON risultante contiene un elenco categorizzato di risultati. I tipi sono tipi di asset diversi dall'inventario, come storage, host, dataStore e così via. Ogni tipo conterrebbe un elenco di oggetti del tipo che corrispondono ai criteri di ricerca.

Data Infrastructure Insights è una soluzione estensibile (completamente aperta) che consente integrazioni con sistemi di orchestrazione, gestione aziendale, controllo delle modifiche e ticketing di terze parti, nonché integrazioni CMDB personalizzate.

L'API RESTful di Cloud Insight è un punto di integrazione primario che consente uno spostamento semplice ed efficace dei dati e consente agli utenti di accedere senza problemi ai propri dati.

Per disabilitare temporaneamente un token API, nella pagina dell'elenco dei token API, fare clic sul menu "tre punti" per l'API e selezionare Disabilita. È possibile riattivare il token in qualsiasi momento utilizzando lo stesso menu e selezionando Abilita.

Per rimuovere definitivamente un token API, seleziona "Revoca" dal menu. Non è possibile riattivare un token revocato; è necessario crearne uno nuovo.

I token di accesso API hanno una data di scadenza. Quando un token di accesso API scade, gli utenti devono generare un nuovo token (di tipo Data Ingestion con autorizzazioni di lettura/scrittura) e riconfigurare Telegraf per utilizzare il token appena generato anziché quello scaduto. Di seguito sono riportati i passaggi dettagliati per procedere.