Das VMware Edge Network Intelligence-System verfügt über eine umfassende schreibgeschützte API, die den Zugriff auf einen Großteil der Daten über eine programmatische Schnittstelle ermöglicht. Diese Integration ermöglicht es Organisationen, VMware Edge Network Intelligence-Daten in andere externe Systeme wie Data Warehouses oder Business Intelligence-Lösungen zu integrieren.

Die VMware Edge Network Intelligence-API ist eine SCHREIBGESCHÜTZTE API, die auf GraphQL basiert. Wenn Sie sich mit GraphQL noch nicht auskennen, raten wir Ihnen, das GraphQL-Handbuch zu lesen, um mehr über das Framework zu erfahren. Ein deutlicher Vorteil von GraphQL gegenüber anderen API-Schnittstellen liegt darin, dass es im Gegensatz zu REST das Abrufen gefilterter Daten per Einzelaufruf ermöglicht.

Aktuell unterstützte Datenelemente

Client

Attribute, Verlauf, Leistung

Anwendung (Application)

Nutzung, Durchsatz

Zugriffspunkt

Attribute, Leistung

Benutzerdefinierte Gruppen

Leistung

Empfehlungen

Details

Globale Beratung

Details

IoT-Sicherheit

Analyse des Verhaltens eines einzelnen Geräts/einer Gruppe

Incidents

Details

Interaktive Untersuchung der API

Innerhalb von VMware Edge Network Intelligence können Sie die API über eine interaktive grafische Benutzeroberfläche (GUI) untersuchen. Um auf die GUI für die API zuzugreifen, müssen Sie bei der VMware Edge Network Intelligence-App authentifiziert sein. Navigieren Sie dann zu: https://<your-ENI-URL>/api/v2/graphiql.

Grenzwert für die API-Rate

Der VMware Edge Network Intelligence-API-Server in der Public Cloud kann 2 Anfragen pro Sekunde verarbeiten. Bis zu 60 Anfragen können gleichzeitig gesendet und in die Warteschlange gestellt werden. Diese werden mit 2 Anfragen pro Sekunde verarbeitet. Wenn mehr als 60 Anfragen gleichzeitig empfangen werden, wird ab der 61. Anfrage der Fehlercode 429 – „Sie haben den Grenzwert für API-Anfragen erreicht (You have hit the API request limit)“ – ausgegeben. Für API-Anfragen auf der Private Cloud-Appliance gilt KEIN Ratengrenzwert.

Generieren eines API-Tokens

Um ein API-Token zu generieren, navigieren Sie zu Ihren Benutzereinstellungen und wählen Sie „Entwickler-API (Developer API)“ aus.

Von dort aus können Sie ein Token generieren, das zur Authentifizierung gegen die API verwendet werden kann.
Abbildung 1. Generieren eines API-Tokens

GitHub-Dokumentation

Weitere Informationen zur API finden Sie in unserem GitHub-Archiv.

Beispiele für APIs

Liste der 5-GHz-fähigen Clients, die sich in den letzten 2 Wochen an einem bestimmten Standort mit 2,4 GHz verbunden haben

Abfragebeispiel

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
}
}
}
}
Abbildung 2. Antwortbeispiel