luci api 中文文档
时间: 2023-11-19 10:03:59 浏览: 188
Luci 是 OpenWrt 系统的 Web 界面,提供了许多网络设置和管理功能。Luci API 是 Luci 的 Web API 接口,可以通过 API 接口实现对 OpenWrt 系统的配置和管理。以下是 Luci API 的中文文档:
1. 登录接口
- 接口地址:/cgi-bin/luci/api/xqsystem/login
- 请求方式:POST
- 参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | -------- | ---- |
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |
| logtype | int | 否 | 日志类型(1:登录,2:注销,默认为1) |
- 返回值:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 返回状态码(0:成功,1:失败) |
| msg | string | 返回信息 |
| token | string | 登录成功后返回的 token |
2. 退出登录接口
- 接口地址:/cgi-bin/luci/api/xqsystem/logout
- 请求方式:POST
- 参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | -------- | ---- |
| token | string | 是 | 登录成功后返回的 token |
- 返回值:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 返回状态码(0:成功,1:失败) |
| msg | string | 返回信息 |
3. 获取设备信息接口
- 接口地址:/cgi-bin/luci/api/xqsystem/get_device_info
- 请求方式:POST
- 参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | -------- | ---- |
| token | string | 是 | 登录成功后返回的 token |
- 返回值:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 返回状态码(0:成功,1:失败) |
| msg | string | 返回信息 |
| data | object | 设备信息对象 |
其中,设备信息对象包含以下属性:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| mac | string | 设备 MAC 地址 |
| fw_version | string | 固件版本号 |
| hw_version | string | 硬件版本号 |
| model | string | 设备型号 |
| rom_version | string | ROM 版本号 |
| channel | string | 无线信道 |
| uptime | string | 设备运行时间 |
| mem | string | 内存使用情况 |
| cpu | string | CPU 使用情况 |
| lan_ip | string | LAN 口 IP 地址 |
| wan_ip | string | WAN 口 IP 地址 |
| online | int | 设备是否在线(0:离线,1:在线) |
4. 获取系统信息接口
- 接口地址:/cgi-bin/luci/api/xqsystem/get_system_info
- 请求方式:POST
- 参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | -------- | ---- |
| token | string | 是 | 登录成功后返回的 token |
- 返回值:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 返回状态码(0:成功,1:失败) |
| msg | string | 返回信息 |
| data | object | 系统信息对象 |
其中,系统信息对象包含以下属性:
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| mem_total | string | 总内存 |
| mem_free | string | 空闲内存 |
| mem_cached | string | 缓存内存 |
| mem_buffers | string | 缓冲区内存 |
| uptime | string | 系统运行时间 |
| loadavg | string | 系统负载 |
以上是 Luci API 的部分接口文档,更多接口请参考 OpenWrt 官方文档。
阅读全文