Il sistema VMware Edge Network Intelligence dispone di un'API avanzata di sola lettura che consente di accedere alla maggior parte dei dati tramite un'interfaccia programmatica. Questa integrazione consente alle organizzazioni di integrare i dati di VMware Edge Network Intelligence in altri sistemi esterni, come data warehouse o soluzioni di business intelligence.

L'API di VMware Edge Network Intelligence è un'API DI SOLA LETTURA basata su GraphQL. Se non si ha familiarità con GraphQL, è consigliabile fare riferimento alla Guida di GraphQL per ulteriori informazioni sul framework. A differenza dalle altre interfacce API, come REST, GraphQL consente il recupero dei dati filtrati tramite una singola chiamata.

Elementi dati attualmente supportati

Client

Attributi, cronologia, prestazioni

Applicazione

Utilizzo, velocità effettiva

Punto di accesso

Attributi, prestazioni

Gruppi personalizzati

Prestazioni

Consigli

Dettagli

Avvisi globali

Dettagli

Sicurezza IoT

Analisi del comportamento di singoli dispositivi o gruppi

Eventi imprevisti (Incidents)

Dettagli

Esplorazione interattiva dell'API

In VMware Edge Network Intelligence è possibile esplorare l'API tramite un'interfaccia grafica interattiva. Per accedere alla GUI per l'API è necessario eseguire l'autenticazione nell'app VMware Edge Network Intelligence. È quindi possibile passare a: https://<URL-ENI>/api/v2/graphiql

Limite di velocità dell'API

Il server dell'API di VMware Edge Network Intelligence nel cloud pubblico può elaborare 2 richieste al secondo. È possibile inviare contemporaneamente e mettere in coda fino a 60 richieste, che verranno elaborate alla velocità di 2 richieste al secondo. Se vengono ricevute più di 60 richieste contemporaneamente, le richieste successive alle prime 60 vengono restituite con il codice di errore 429 che indica che è stato raggiunto il limite di richieste per l'API. Non c'è alcun limite di velocità per le richieste dell'API nell'appliance del cloud privato.

Generazione di un token API

Per generare un token API, passare alle preferenze utente e scegliere Developer API.

Da qui è possibile generare un token che può essere utilizzato per l'autenticazione nell'API.
Figura 1. Generazione di un token API

Documentazione di GitHub

Per ulteriori informazioni sull'API, fare riferimento al repository di GitHub

Esempi di API

Elenco di client che supportano 5 GHz e si sono connessi a 2,4 GHz nelle ultime 2 settimane in una posizione specifica

Query di esempio

query{
 deviceList(filters:{
    op:AND,
     filters:[
      {field:"rfBand", value:"2"},
        {field:"is5ghzCapable", value:"true"}
     ]
}){
totalCount
devices {
hostname
macAddr
is5ghzCapable
rfBand
userName
isIotDevice
apDwellTimeMs
createdAt
deviceTypeDetails {
model
osAndVersion
deviceClass
}
}
}
}
Figura 2. Risposta di esempio