智驱力社区

1. 查询设备信息

接口功能描述：设备信息以及设备状态查询；
接口路径：[GET] http://云服务IP:9191/ks/proxy/device；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	否	设备ID

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	返回数据

响应示例。

项目

详情

报文格式

JSON

报文内容

{
"data": [
    {
      "desc": "",
      "id": "40b44373-765e-4d24-94dc-89e54f898158",
      "infer_freq": 25.0,
      "name": "边缘节点-234",
      "max_source": 32,
      "status": 1, //1：在线，0：离线
"ipv4": "192.168.1.169",
"hardware_version": "ks968-m2",
"software_version": "3.0.0",
    }
],
"error_code": 0,
"message": {
        "zh": "查询设备成功！",
        "en": "Query device successful!"
    }
}

2. 重启设备

接口功能描述：对在线设备进行重启；
接口路径：[POST] http://云服务IP:9190/ks/proxy/device/reboot；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["20e0c32b-f937-4cf2-9e8c-96d1e60e6519"] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	以对象形式返回每个设备是否重启成功，result:结果，reason:原因

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "result": true, //true重启成功，false，重启失败 "reason": null } }, "error_code": 0, "message": { "zh": "重启设备成功！", "en": "Reboot device successful!" } }

3. 获取设备系统资源

接口功能描述：获取盒子设备系统资源（CPU、内存、磁盘）；
接口路径：[GET] http://云服务IP:9191/ks/proxy/system/resource；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8

响应参数说明

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回资源占用百分比

响应示例

项目	详情
报文格式	JSON
报文内容	{ "data": { cpu_percent: 1.6, //cpu使用占比 disk_percent: 5.9, //磁盘使用占比 memory_percent: 14.6 //内存使用占比 }, "error_code": 0, "message": { "zh": "查询系统资源成功！", "en": "Query system resource successful!" } }

4. 软件升级

接口功能描述：盒子设备软件升级；
接口路径：[POST] http://云服务IP:9191/ks/proxy/version/package/device；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_ids	String	是	设备ID数组
package	File	是	升级包，必须为.zip

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["20e0c32b-f937-4cf2-9e8c-96d1e60e6519"]
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否升级成功，result:结果，reason:原因

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "升级设备完成", "en": "Upgrade device successful!" } }

5. 获取设备运行日志

接口功能描述：获取盒子设备软件与算法运行日志；
接口路径：[GET] http://云服务IP:9191/ks/proxy/log/device；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

1. 查询设备信息

2. 重启设备

3. 获取设备系统资源

4. 软件升级

5. 获取设备运行日志

设备管理