Le informazioni API più recenti si trovano accedendo a Cloud Insights e accedendo a Amministratore > 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 ambiente. A seconda del ruolo dell'utente e/o dell'edizione di Cloud Insights, i tipi di API disponibili possono variare.

Prima di utilizzare l'API Cloud Insights, è necessario creare uno o più token di accesso API. I token di accesso vengono utilizzati per tipi di API specifici e possono concedere permessi di lettura e/o scrittura. È inoltre possibile impostare la scadenza per ciascun token di accesso. Tutte le API dei tipi specificati sono valide per il token di accesso. Ogni token non contiene un nome utente o una password.

Per creare un token di accesso:

È possibile disattivare, attivare e revocare i token. È possibile attivare i token disattivati.

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 Cloud Insights.

L'applicazione riceve un token di accesso dopo che un utente ha autenticato e autorizzato l'accesso, quindi passa il token di accesso come credenziale quando chiama l'API di destinazione. Il token passato informa l'API che la portante del token è stata autorizzata 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 storage:

Consulta le pagine swagger per esempi specifici dell'API che desideri utilizzare.

L'API Cloud Insights è basata sulle categorie e attualmente contiene i seguenti tipi:

Altri tipi e/o API potrebbero diventare disponibili nel tempo. Le informazioni API più recenti sono disponibili in "Documentazione API Swagger".

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

In questa sezione viene descritto come attraversare una gerarchia di oggetti Cloud Insights.

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

L'unico parametro di espansione comune è Expands. La risposta contiene un elenco di tutte le espansi 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 nidificati, ad esempio:

Per scoraggiarlo, non è possibile espandere le richieste di raccolte di livello superiore. Ad esempio, non è possibile richiedere l'espansione dei dati per tutti gli oggetti di storage contemporaneamente. I client devono recuperare l'elenco di oggetti e scegliere gli oggetti specifici da espandere.

I dati sulle performance vengono raccolti su molti dispositivi come campioni separati. Ogni ora (impostazione predefinita), Cloud Insights aggrega e riepiloga i campioni di performance.

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

Esempi di oggetti dati sulle performance includono:

Una metrica delle performance ha una descrizione e un tipo e contiene una raccolta di riepiloghi delle performance. Ad esempio, latenza, traffico e velocità.

Un Riepilogo delle performance contiene una descrizione, un'unità, un'ora di inizio del campione, un'ora di fine del campione e un insieme di valori riepilogati (corrente, min, max, media, ecc.) calcolati da un singolo contatore delle performance in un intervallo di tempo (1 ora, 24 ore, 3 giorni e così via).

Il dizionario dei dati sulle prestazioni risultante dispone delle seguenti chiavi:

Ogni tipo di oggetto dati sulle performance ha un insieme unico di metriche delle performance. Ad esempio, l'oggetto performance della macchina virtuale supporta "diskThroughput" come metrica delle performance. Ogni metrica di performance supportata è di una determinata "performanceCategory" presentata nel dizionario delle metriche. Cloud Insights supporta diversi tipi di metriche delle performance elencati più avanti in questo documento. Ogni dizionario delle metriche di performance avrà anche il campo "description" (Descrizione) che è una descrizione leggibile di questa metrica di performance e una serie di voci del contatore di riepilogo delle performance.

Il contatore Performance Summary è il riepilogo dei contatori delle performance. Presenta i valori aggregati tipici come min, max e AVG per un contatore e anche 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; gli altri attributi sono obbligatori.

Sono disponibili riepiloghi delle performance per i seguenti tipi di contatori:

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

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

I dati della cronologia vengono presentati nei dati delle performance come un elenco di coppie di timestamp e mappe dei contatori.

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

Di seguito viene riportato un esempio di dati JSON relativi alle performance 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 diversi tipi di risorse dall'inventario, ad esempio storage, host, datastore e così via. Ogni tipo contiene un elenco di oggetti del tipo che corrispondono ai criteri di ricerca.

Cloud Insights è una soluzione estensibile (ampiamente aperta) che consente integrazioni con sistemi di orchestrazione, gestione aziendale, controllo delle modifiche e ticketing di terze parti, oltre a integrazioni CMDB personalizzate.

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

Per disattivare temporaneamente un token API, nella pagina di elenco dei token API, fare clic sul menu "tre punti" dell'API e selezionare Disable. Puoi riattivare il token in qualsiasi momento utilizzando lo stesso menu e selezionando Enable.

Per rimuovere in modo permanente un token API, selezionare "revoca" dal menu. Non è possibile riattivare un token revocato; è necessario creare un nuovo token.

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 permessi di lettura/scrittura) e riconfigurare Telegraf per utilizzare il token appena generato invece del token scaduto. La procedura riportata di seguito illustra in dettaglio la procedura da seguire.