Commands 命令，可以执行 shell 命令

执行 shell 命令

POST /api/commands/run

POST data:

  1. {
  2.   "cmd": "echo 'hello modou'"
  3. }

return data:

  1. {
  2.   "code"      : 0                             // 返回码, 0 成功，非0失败
  3.   "output"    : ""                            // shell 执行的结果
  4. }

获取执行 shell 命令历史

GET /api/commands/history

return data:

  1. {
  2.   "code"      : 0                             // 返回码, 0 成功，非0失败
  3.                                               // 执行的 shell 历史
  4.   "cmds"      : [
  5.     {
  6.       "id"    : "12345678",
  7.       "cmd"   : "echo modou"
  8.     },
  9.     ...
  10.   ]
  11. }

搜索热点信息

GET /api/apclient/survey?deviceAlias=5g /
2g, rt2860(ra0, 2.4G);
5g, mt7610/rtdev(raii0, 5G) /

return data:

  1. {
  2.     "code"   : 0                // 0, 成功; -1, 失败
  3.     "survey" : [
  4.         {
  5.             "channel"    :   "161",
  6.             "ssid"       :   "Modou-1234",
  7.             "bssid"      :   "24:de:c6:5a:19:d8", // MAC address
  8.             "security"   :   "WPA1PSKWPA2PSK", // OPEN, WPAPSK, WPA2PSK, WPA1PSKWPA2PSK
  9.             "encrypType" :   "TKIPAES",  // NONE, WEP, TKIP, AES, TKIPAES
  10.             "signal"     :   "99",
  11.             "w-Mode"     :   "11a/n"
  12.         },
  13.         ...
  14.     ]
  15. }

连接到 AP

POST /api/apclient/connectToAP

post data:

  1. {
  2.     /*2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */
  3.     "deviceAlias"    :  "5g", 
  4.     "connectionInfo" :  {
  5.         "channel"    :  "161",
  6.         "ssid"       :  "modou-0a10",
  7.         "bssid"      :  "24:de:c6:5a:19:d8", // MAC address
  8.         "security"   :  "WPA1PSKWPA2PSK", // OPEN, WPAPSK, WPA2PSK, WPA1PSKWPA2PSK
  9.         "encrypType" :  "TKIPAES",  // NONE, WEP, TKIP, AES, TKIPAES
  10.         "password"   :  "12345678"  
  11.     }
  12. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; -1, 失败
  3.     "msg"    : "Error Message" 
  4. }

断开 AP Client 连接

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/disconnect?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; -1, 失败
  3.     "msg"    : "Error Message" 
  4. }

重新连接到 AP

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/reconnectToAP?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; -1, 失败
  3.     "msg"    : "Error Message" 
  4. }

使能 AP Client

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/eableAPClient?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; -1, 失败
  3.     "msg"    : "Error Message" 
  4. }

关闭 AP Client

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/disableAPClient?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; -1, 失败
  3.     "msg"    : "Error Message" 
  4. }

获取 AP Client 当前状态

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/apClientStatus?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, disable; 1, enable; -1, 获取状态失败
  3.     "msg"    : "Error Message" 
  4. }

获取上一次的连接信息

/ 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) /
GET /api/apclient/prevConnectionInfo?deviceAlias=5g

return data:

  1. {
  2.     "code"   : 0,                // 0, disable; 1, enable; -1, 获取状态失败
  3.     "msg"    : "Error Message" 
  4. }

测试连上路由器的速度

不需要身份验证

GET /api/speedtest?size=1024

size 以 KB 为单位

QoS设置

设定优先模式

POST /api/qos/set_mode

post data:

  1. {
  2.     "mode"  : "vip"              // 优先级模式, 暫支持none|vip|speedlimit|game
  3. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

查询优先模式

GET /api/qos/get_mode

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "mode"   : "vip"             // 优先级模式, none,vip,speedlimit
  4.     "msg"    : "Error Message"   
  5. }

开启/关闭智能QoS

POST /api/qos/set_smart

post data:

  1. {
  2.     "enable" :  true/false       // true，开启；false, 关闭
  3. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

获取智能QoS状态

GET /api/qos/get_smart

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "enabled":  true/false       // true，开启；false, 关闭
  4.     "msg"    : "Error Message" 
  5. }

设置设备的优先级（仅QoS为VIP优先模式时有效）

POST /api/qos/set_prio

post data:

  1. {
  2.     "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
  3.     "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
  4.     "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
  5. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

删除设备的优先级（仅QoS为VIP优先模式时有效）

POST /api/qos/rm_prio

post data:

  1. {
  2.     "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
  3.     "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
  4.     "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
  5. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

查询优先级配置（仅QoS为VIP优先模式时有效）

GET /api/qos/vip_config

return data:

  1. { "code" : 0,
  2.   "conf" : [
  3.     [
  4.         {
  5.             "ip"    : "192.168.18.121",     // 被设置优先级的设备的IP地址
  6.             "mac"   : "11:22:33:44:55:61",  // 被设置优先级的设备的MAC地址
  7.             "prio"  : 1                     // 优先级，数值小的优先级高;目前支持1,2,3
  8.         },
  9.         ......
  10.     ],
  11.     [
  12.         {
  13.             "ip"    : "192.168.18.122",     // 被设置优先级的设备的IP地址
  14.             "mac"   : "11:22:33:44:55:62",  // 被设置优先级的设备的MAC地址
  15.             "prio"  : 2                     // 优先级，数值小的优先级高;目前支持1,2,3
  16.         },
  17.         ......
  18.     ],
  19.     [
  20.         {
  21.             "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
  22.             "mac"   : "11:22:33:44:55:63",  // 被设置优先级的设备的MAC地址
  23.             "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
  24.         },
  25.         ......
  26.     ] 
  27. ]}

设置设备的速度限制（仅QoS为speedlimit模式时有效）

POST /api/qos/set_bandwidth

post data:

  1. {
  2.     "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
  3.     "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
  4.     "up"    : 100,
  5.     "down"  : 500
  6. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

删除设备的速度限制（仅QoS为speedlimit模式时有效）

POST /api/qos/rm_bandwidth

post data:

  1. {
  2.     "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
  3.     "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
  4.     "up"    : 100,
  5.     "down"  : 500
  6. }

return data:

  1. {
  2.     "code"   : 0,                // 0, 成功; 非0失败
  3.     "msg"    : "Error Message" 
  4. }

查询网速限制配置（仅QoS为speedlimit模式时有效）

GET /api/qos/bandwidth_config

return data:

  1. { "code" : 0,
  2.   "conf" : [
  3.     [
  4.         {
  5.             "ip"    : "192.168.18.121",     // 被限制设备的IP
  6.             "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
  7.             "up"    : 100,                  // 上行带宽限制,单位 kbps
  8.             "down"  : 500                   // 下行宽限制,单位 kbps
  9.         },
  10.         ......
  11.     ],
  12.     [
  13.         {
  14.             "ip"    : "192.168.18.121",     // 被限制设备的IP
  15.             "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
  16.             "up"    : 100,                  // 上行带宽限制,单位 kbps
  17.             "down"  : 500                   // 下行宽限制,单位 kbps
  18.         },
  19.         ......
  20.     ],
  21.     [
  22.         {
  23.             "ip"    : "192.168.18.121",     // 被限制设备的IP
  24.             "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
  25.             "up"    : 100,                  // 上行带宽限制,单位 kbps
  26.             "down"  : 500                   // 下行宽限制,单位 kbps
  27.         },
  28.         ......
  29.     ] 
  30. ]}

截图

GET /api/screenshot

Response Data:

  1. {
  2.   "code": 0,                // 0, 成功; -1, 失败
  3.   "url": "http://image.url"
  4. }