WebSocket API 概述
您可以在瞻博网络 Mist 网络中使用 WebSockets。WebSocket 协议可以在客户端和服务器之间打开双向通信会话。您可以向服务器发送消息并接收事件驱动的实时响应,而无需轮询服务器以获取回复。
初始客户端请求和服务器响应使用 HTTP 协议建立 WebSocket 通信。从那时起,客户端可以订阅一个或多个主题(流通道)来流式传输数据。
您和其他管理员可以在非常具体的用例中使用 WebSockets,例如必须反映实时数据值的数据可视化仪表板或地图。
例子
-
使用瞻博网络 Mist 接入点 (AP) 的实时状态和蓝牙低功耗 (BLE) 资产的实时位置数据填充自定义仪表板。
-
每小时将设备数据和统计信息(例如传输和接收数据包)流式传输到 Grafana 等外部操作仪表板。尽管设备统计信息很可靠,但您可以轻松地解析它们以抽象出所需的数据进行显示。
WebSocket API 端点
API 终端节点取决于您的组织关联的全局区域。请参阅 API 终端节点和全局区域 。
身份验证选项
瞻博网络 Mist 需要通过身份验证才能建立与 WebSocket API 的连接。您可以使用以下方法:
-
使用瞻博网络 Mist 登录凭据进行 HTTP 登录
-
对外部 OAuth2 提供程序的 API 调用
WebSocket 流媒体频道
瞻博网络 Mist 与客户端建立流连接后,客户端需要订阅至少一个通道才能发送和接收消息。消息通过双向 WebSocket 协议来回传输。要停止从某个频道发送和接收消息,您可以取消订阅该频道。
所有通道都要求您指定站点 ID。要在瞻博网络 Mist 门户中查找站点 ID,请从左侧菜单中选择 “组织>站点配置 ”,然后单击该站点。
登录后,您可以查看有关每个 WebSocket 的更多信息。
您的文档链接将取决于您登录的区域(云)。
名称 | 流通道 | 文档 |
---|---|---|
发现 BLE 资产 | /sites/:site_id/stats/maps/:map_id/discovered_assets | https://api.mist.com/api/v1/docs/Site#assets |
BLE 资产位置 | /sites/:site_id/stats/maps/:map_id/assets | https://api.mist.com/api/v1/docs/Site#assets |
BLE 资产射频玻璃信息 | /sites/:site_id/assets/:asset_id/diag | https://api.mist.com/api/v1/docs/Site#location |
SDK 客户端位置 | /sites/:site_id/stats/maps/:map_id/sdkclients | https://api.mist.com/api/v1/docs/Site#location |
SDK 客户端射频玻璃信息 | /sites/:site_id/sdkclients/:sdkclient_id/diag | https://api.mist.com/api/v1/docs/Site#location |
Wi-Fi(客户端位置) | /sites/:site_id/stats/maps/:map_id/clients | https://api.mist.com/api/v1/docs/Site#client-stats |
Wi-Fi 客户端统计信息 | /sites/:site_id/stats/clients | https://api.mist.com/api/v1/docs/Site#client-stats |
Wi-Fi 客户端射频玻璃信息 | /sites/:site_id/clients/:client_mac/diag | https://api.mist.com/api/v1/docs/Site#location |
未连接的客户端 | /sites/:site_id/stats/maps/:map_id/unconnected_clients | https://api.mist.com/api/v1/docs/Site#location |
设备 | /sites/:site_id/devices | https://api.mist.com/api/v1/docs/Site#device |
设备统计信息 | /sites/:site_id/stats/devices | https://api.mist.com/api/v1/docs/Site#device |
来自设备的命令 | /sites/:site_id/devices/:d evice_id/cmd | https://api.mist.com/api/v1/docs/Site#device |
流式 PCAP | /sites/:site_id/pcaps | https://api.mist.com/api/v1/docs/Site#subscribe-to-streaming-pcap |