“物联网透传工具”HTTP API文档(二)

        “物联网透传工具”是用于远程读取传感器和控制硬件设备的透传解决方案,其HTTP API文档第二部分如下:

9. 查询循环指令

功能

查询当前是否有循环指令在执行

方法

POST

请求地址

https://domain/api/v1/cmd-loop-query

请求参数

  • token

        token。

  • terminalId      

        终端ID。

举例

https://domain/api/v1/cmd-loop-query?token=xxxxx&terminalId=xxxxxx

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "exist": false

}

}

备注

10. 查询终端系统信息

功能

查询当前终端系统信息,包括CPU,内存使用情况

方法

POST

请求地址

https://domain/api/v1/cmd-sys-info

请求参数

  • token

   token。

  • terminalId      

终端ID。

举例

https://domain/api/v1/cmd-sys-info?token=xxxxx&terminalId=xxxxxx

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "cpuRate": 20,    //CPU占有率20%

  "memFree": 500620,  //可用内存,单位KB

  "memTotal":1500905  //总内存,单位KB 

}

}

备注

11. 启动终端中进程

功能

启动终端系统中的进程

方法

POST

请求地址

https://domain/api/v1/cmd-process-start

请求参数

  • token

   token。

  • terminalId      

终端ID。

举例

https://domain/api/v1/cmd-process-start?token=xxxxx&terminalId=xxxxxx

Windows举例:

{

  "processPath": "D:\\Notepad++\\notepad++.exe",

  "processParam": null,

  "returnResult": null

}

Linux举例:

{

  "processPath": "/usr/bin/ps",

  "processParam": "-ef",

  "returnResult": true

}

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "processId": 4520,

  "result": "xxxxxxxxxxxxxxxx"   

}

}

备注

12 终止终端中进程

功能

终止终端系统中的进程

方法

POST

请求地址

https://domain/api/v1/cmd-process-stop

请求参数

  • token

   token。

  • terminalId      

终端ID。

  1. processId

进程ID

举例

https://domain/api/v1/cmd-process-stop?token=xxxxx&terminalId=xxxxxx&processId=xxxxx

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": null

}

备注

13 终止终端中进程

功能

终止终端系统中的进程

方法

POST

请求地址

https://domain/api/v1/cmd-process-stop

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • processId

进程ID

举例

https://domain/api/v1/cmd-process-stop?token=xxxxx&terminalId=xxxxxx&processId=xxxxx

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": null

}

备注

14 查询终端中进程是否存在

功能

查询终端系统中的进程是否存在

方法

POST

请求地址

https://domain/api/v1/cmd-process-query

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • processId

进程ID

举例

https://domain/api/v1/cmd-process-stop?token=xxxxx&terminalId=xxxxxx&processId=xxxxx

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "exist": true

}

}

备注

15 查询终端中文件大小

功能

查询终端系统中的文件大小

方法

POST

请求地址

https://domain/api/v1/cmd-file-size

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • 文件信息

filePath:文件绝对路径

举例

https://domain/api/v1/cmd-file-size?token=xxxxx&terminalId=xxxxxx

{

  "filePath": "/home/abc/abc.log"

}

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "fileSize": 5648210   //单位字节

}

}

备注

16 获取终端中文件内容

功能

获取终端系统中的文件内容

方法

POST

请求地址

https://domain/api/v1/cmd-file-read

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • 文件信息

filePath:文件绝对路径

startPos:文件起始位置

length:读取长度,0表示从起始点读取剩余全部

举例

https://domain/api/v1/cmd-file-read?token=xxxxx&terminalId=xxxxxx

{

  "filePath": "/home/abc/abc.log"

  "startPos": 0,

  "length": 0

}

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": {

  "content": "xxxxxxxx"  //base64编码

}

}

备注

单次读取内容不超过60KB

17 向终端中文件中写入内容

功能

向终端中文件中写入内容

方法

POST

请求地址

https://domain/api/v1/cmd-file-write

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • 文件信息

filePath:文件绝对路径

startPos:文件起始位置。-1表示从结尾写。

content:"xxxxxxx"   //base64编码

举例

https://domain/api/v1/cmd-file-write?token=xxxxx&terminalId=xxxxxx

{

  "filePath": "/home/abc/abc.log"

  "startPos": 1000,

  "content": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

}

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": null

}

备注

单次写入内容不超过60KB

18 删除终端中文件

功能

删除终端中文件

方法

POST

请求地址

https://domain/api/v1/cmd-file-delete

请求参数

  • token

   token。

  • terminalId      

终端ID。

  • 文件信息

filePath:文件绝对路径

举例

https://domain/api/v1/cmd-file-write?token=xxxxx&terminalId=xxxxxx

{

  "filePath": "/home/abc/abc.log"  

}

返回结果示例

{

  "code": 200,

  "msg": "成功",

"data": null

}

备注

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值