Úvod do rozhraní API

Systém VMware Edge Network Intelligence má bohaté rozhraní API pouze pro čtení, které umožňuje přístup k velkému množství dat prostřednictvím programového rozhraní. Díky této integraci mohou organizace integrovat data pocházející z VMware Edge Network Intelligence do dalších externích systémů, jako jsou například datové sklady nebo řešení využívající analytických nástrojů.

Rozhraní API aplikace VMware Edge Network Intelligence je rozhraní API POUZE PRO ČTENÍ založené na Graph QL. Pokud nejste obeznámeni s GraphQL, doporučujeme, abyste navštívili Průvodce GraphQL (GraphQL guide), kde naleznete více informací o tomto rámci. Jedna výrazná výhoda, kterou má Graph QL oproti jiným rozhraním API, spočívá v tom, že umožňuje, na rozdíl od rozhraní REST, jednohovorové načítání filtrovaných dat.

Aktuálně podporované datové prvky


Klient	Atributy, historie, výkonnost
Aplikace (Application)	Využití, propustnost
Přístupový bod	Atributy, výkonnost
Vlastní skupiny	výkon
Doporučení	detaily
Globální poradenství	detaily
Zabezpečení IoT	Analýza chování jednoho zařízení / skupiny
Incidenty	detaily

Interaktivní poznávání API

V rámci aplikace VMware Edge Network Intelligence můžete rozhraní API prozkoumat pomocí interaktivního grafického rozhraní. Pro přístup k GUI pro rozhraní API musíte být autentizováni pro aplikaci VMware Edge Network Intelligence a poté můžete přejít na adresu: https://<your-ENI-URL>/api/v2/graphiql

Limit rychlosti rozhraní API

Server API aplikace VMware Edge Network Intelligence ve veřejném cloudu může zpracovat 2 požadavky za sekundu. Najednou může být posíláno a zařazeno do fronty až 60 požadavků; tyto budou zpracovány rychlostí 2 požadavky za sekundu. Pokud je najednou přijato více než 60 požadavků, budou požadavky po prvních 60 vráceny s chybovým kódem 429 – „Dosáhli jste limitu požadavků na rozhraní API“. Požadavky na rozhraní API na zařízení privátního cloudu NEJSOU omezeny rychlostí.

Generování tokenu API

Pro vygenerování tokenu API přejděte do svých uživatelských preferencí a vyberte možnost Rozhraní API pro vývojáře (Developer API).

Odtud můžete vygenerovat token, který může být použit pro autentizaci na rozhraní API.

VMware Edge Network Intelligence – Generování tokenu API (VMware Edge Network Intelligence - Generating an API token) — Obrázek 1. Generování tokenu API

Dokumentace GitHub

Více informací o API naleznete na naší GitHub repo

Příklady rozhraní API

Seznam klientů s podporou 5 GHz, kteří se připojují k 2,4 GHz v posledních 2 týdnech v konkrétní lokaci

Vzorový dotaz

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
}
}
}
}