云手机API详解
API版本:V1_0
1. 请求连接构造实例:
```javascript
const HTTP = require('http');
const first = 'http://x.x.x.x:3001/api/1_0';
const api = first + '/systeminfo';
HTTP.get(api, function (err, res) {}).done(function () {});
```
2. GET /systeminfo
功能说明:获取设备信息;
是否需要授权:否;
参数说明:
a、其中包含了系统的版本信息等
b、其中包含了硬盘的容量信息,包括总容量、可用容量和已用容量等
返回值:
{
"data": {
"id": "1",
"dev": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"mac": "02:42:53:7e:6b:88",
"cpu": "3.38%",
"mem": "57.44%--15.57GB",
"fs": "",
"net": "",
"version": "1.1.35",
"sDisk": "13.52%-57.79GB",
"nvmDisk": "11.87%-468.38GB",
"temp": "52.69°C",
"desc": "授权有效,截止时间:2024-10-12 15:48:20",
"license": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=="
}
}
3. POST /licenses
功能说明:设置设备授权信息;
是否需要授权:否;
参数说明:
a、post json data:实例如下
{
"license": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=="
}
b、返回JSON参数,实例如下:valid=true或者false,如果为true,则表示授权成功,否则为false;
{
"valid": true
}
4. GET /get_container_list
功能说明:获取当前云手机列表;
是否需要授权:否;
参数说明:
a、返回JSON参数
5. GET /get_online_index
功能说明:获取可用来创建云手机的索引;
是否需要授权:是;
参数说明:
a、返回数字值
6. GET /get_img_list
功能说明:获取MX提供的镜像列表;
是否需要授权:是;
参数说明:
a、返回JSON参数
7. GET /get_model_list
功能说明:获取MX提供的机型列表;
是否需要授权:是;
参数说明:
a、返回JSON参数
8. GET /create_container/:tag/:index/:model
功能说明:根据提供的镜像名、索引、机型创建云手机;
是否需要授权:是;
案例:"/create_container/mx-20240919-cn-tp/1/Redmi-Note-7"
参数说明:
a、返回true或者false
9. GET /run/:id
功能说明:启动云手机;
是否需要授权:是;
参数说明:
a、返回true或者false
10. GET /stop/:id
功能说明:关闭云手机;
是否需要授权:是;
参数说明:
a、返回true或者false
11. GET /remove/:id
功能说明:删除云手机;
是否需要授权:是;
参数说明:
a、返回true或者false
12. GET /updatedeclare/:id/:declare
功能说明:更新云手机描述;
是否需要授权:是;
参数说明:
a、返回true或者false
13. POST /s5_set
功能说明:设置云手机代理信息;
是否需要授权:是;
参数说明:
a、post json data:实例如下
{
"id": "1",
"proxyurl": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
b、返回JSON参数,实例如下:valid=true或者false,如果为true,则表示设置成功,否则为false;
{
"valid": true
}
14. GET /s5_query/:id
功能说明:获取云手机代理信息;
是否需要授权:是;
参数说明:
a、返回JSON参数,其中包含代理状态信息
15. GET /s5_start/:id
功能说明:启动云手机代理;
是否需要授权:是;
参数说明:
a、返回true或者false
16. GET /s5_stop/:id
功能说明:关闭云手机代理;
是否需要授权:是;
参数说明:
a、返回true或者false
17. GET /install_image/:tag
功能说明:安装镜像;
是否需要授权:是;
参数说明:
a、返回true或者false
18. GET /remove_image/:tag
功能说明:删除镜像;
是否需要授权:是;
参数说明:
a、返回true或者false