雲手機 API 詳解
API 版本:V1_0
1. 請求連接構造實例:
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、 其中包含了硬碟的容量資訊,包括總容量、可用容量和已用容量等
返回值:
```json
{
"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:實例如下
```json
{
"license": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=="
}
```
b、 返回 JSON 參數,實例如下:valid=true 或者 false,如果為 true,則表示授權成功,否則為 false;
```json
{
"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:實例如下
```json
{
"id": "1",
"proxyurl": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
b、 返回 JSON 參數,實例如下:valid=true 或者 false,如果為 true,則表示設定成功,否則為 false;
```json
{
"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