设备管理页面组件
功能描述
设备管理页面组件是一个纯URL的网页，提供了以下功能：
- 远程配置设备
- 远程升级设备
- 远程导入白名单
该组件可以通过iframe的方式快速集成到您的系统中，后续还会增加更多功能。
接口描述
通过此接口获取设备管理页面组件的URL地址，然后可以在您的系统中通过iframe嵌入。
| 接口ID | 协议 | 方法 | PATH |
|---|---|---|---|
| 26 | HTTPS | POST | /openapi/v1/stp/pages/device_manager |
PATH参数
无
URL参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| accesskey_id | string | 是 | 参见签名认证 |
| expires | int | 是 | 参见签名认证 |
| signature | string | 是 | 参见签名认证 |
HTTP请求头
| 字段 | 值 |
|---|---|
| Content-Type | application/json |
请求参数
请求参数以Json格式放置于Body中，字段如下：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| expires | int | 是 | 过期时间，单位：秒，范围：1~86400 |
请求示例
POST /openapi/v1/stp/pages/device_manager?accesskey_id=TeVvn64NG125Wuk0aWvnbYA18sttdTa3&expires=1744109691&signature=Nicom%2FuO7qQC1beAtIWMwzw9wgE%3D HTTP/1.1
Host: open.vzicloud.com
Content-Type: application/json
{
"expires": 86400
}
返回说明
返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| url | string | 设备管理页面组件的URL地址 |
注意：接口返回的url包含有效期，请勿将返回的url存储长期使用，过期后将无法访问。
返回示例
{
"url": "https://open.vzicloud.com/#/open-pages/device-manager?token=VhkGDKjx29gSjOeaGtLtAoCSbY5yF6n-FOV5UABsdgeI5sYB7lbho9hFRPYfYKVTclj0B7pQmqKTG_zKBcK6Jeo"
}
使用步骤
第一步：配置服务端AccessKey的接口权限
请确保您的AccessKey具有调用以下接口的权限：
- 遍历分组（接口ID：8）
- 遍历设备（接口ID：4）
- 统计设备状态（接口ID：27）
- 遍历固件（接口ID：28）
- 遍历升级任务（接口ID：29）
- 创建升级任务（接口ID：30）
- 下载升级文件（接口ID：31）
- 取消升级任务（接口ID：32）
- 遍历配置任务（接口ID：33）
- 创建配置任务（接口ID：34）
- 下载配置文件（接口ID：35）
- 取消配置任务（接口ID：36）
- 遍历导入白名单任务（接口ID：37）
- 创建导入白名单任务（接口ID：38）
- 下载导入白名单文件（接口ID：39）
- 取消导入白名单任务（接口ID：40）
配置方式参考下图：
第二步：在服务端获取设备管理页面组件的地址
使用您的服务端程序调用上述接口，获取设备管理页面组件的URL地址，然后将此地址返回给前端页面。
重要提示：由于URL包含认证信息和有效期，每次需要使用时实时获取，不要长期存储。
第三步：前端页面通过iframe嵌入
在您的前端页面中，使用iframe标签嵌入设备管理页面组件：
<iframe
src="https://open.vzicloud.com/#/open-pages/device-manager?token=VhkGDKjx29gSjOeaGtLtAoCSbY5yF6n-FOV5UABsdgeI5sYB7lbho9hFRPYfYKVTclj0B7pQmqKTG_zKBcK6Jeo"
width="100%"
height="600px"
frameborder="0">
</iframe>
第四步：使用设备管理页面组件
成功嵌入后，您可以直接在iframe中使用设备管理页面组件提供的所有功能：
- 远程配置设备
- 远程升级设备
- 远程导入白名单
组件预览：
