VMware Edge Network Intelligence 系统具有一个丰富的只读 API,可用于通过编程接口访问大量数据。通过该集成,组织可以将 VMware Edge Network Intelligence 数据集成到其他外部系统中,例如数据仓库或商业智能解决方案。

VMware Edge Network Intelligence API 是一个基于 GraphQL 的只读 API。如果您不熟悉 GraphQL,建议您访问 GraphQL 指南以获取有关该框架的更多信息。GraphQL 与其他 API 接口相比的一个明显优势是,它可以通过单次调用提取筛选的数据,这一点与 REST 不同。

当前支持的数据元素

客户端

属性、历史记录、性能

应用程序

使用量、吞吐量

接入点

属性、性能

自定义组

性能

建议

详细信息

全球咨询

详细信息

IoT 安全

单个设备/组行为分析

事件

详细信息

以交互方式浏览 API

在 VMware Edge Network Intelligence 中,您可以通过交互式图形界面浏览该 API。要访问该 API 的 GUI,您必须在 VMware Edge Network Intelligence 应用程序中进行身份验证,然后才能导航到 https://<your-ENI-URL>/api/v2/graphiql。

API 速率限制

公有云上的 VMware Edge Network Intelligence API 服务器每秒可以处理 2 个请求。每次最多可以发送 60 个请求并将其排队;这些请求将以每秒 2 个请求的速度进行处理。如果同时收到超过 60 个请求,前 60 个请求之后的请求将返回 429 错误代码 -“您已达到 API 请求限制”(You have hit the API request limit)。私有云设备上的 API 请求不受速率限制。

生成 API 令牌

要生成 API 令牌,请导航到用户首选项,然后选择“开发人员 API”(Developer API)。

从该位置中,您可以生成一个令牌,它可用于在该 API 中进行身份验证。
图 1. 生成 API 令牌

GitHub 文档

有关该 API 的更多详细信息,请参阅我们的 GitHub 存储库

API 示例

最近 2 周在特定位置中以 2.4GHz 连接并支持 5GHz 的客户端列表

示例查询

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
}
}
}
}
图 2. 示例响应