duizeAIO Development
API 接口用于让外部脚本、运维平台或自动化系统读取 duizeAIO 的基础运行信息。为了降低系统安全风险，公开文档只展示系统健康、状态查询和硬件监控类只读接口。
用户、权限、文件、应用、网站、数据库、配置修改、重启、清理、备份恢复等管理类或写操作 API 不开放，不在公开文档中展示，也不应作为外部集成入口使用。
| 项目 | 说明 | 建议 |
|---|---|---|
| API Key | 调用接口时使用的访问凭据。 | 只保存在服务端环境变量或密钥系统中。 |
| 有效期 | 密钥可用时间，过期后需要更新。 | 生产环境设置明确轮换周期。 |
| IP 白名单 | 只有白名单内 IP 可以访问 API，支持 IPv4 和 IPv6。 | 优先填写固定出口 IP。 |
| HTTPS | 建议通过 HTTPS 调用面板 API。 | 不在明文链路上传输 API Key。 |
以下接口为公开文档允许展示的 duizeAIO 查询接口。所有接口均以面板 API 根路径 /api/v2 为前缀。
| 分类 | 方法 | 路径 | 用途 |
|---|---|---|---|
| 系统健康 | GET | /core/settings/search/available | 查询主控系统可用状态。 |
| 系统健康 | GET | /settings/search/available | 查询节点系统可用状态。 |
| 系统硬件 | GET | /dashboard/base/os | 查询操作系统基础信息。 |
| 系统状态 | GET | /dashboard/base/:ioOption/:netOption | 查询首页基础状态，包含系统使用率、负载和硬件概要。 |
| 系统状态 | GET | /dashboard/current/:ioOption/:netOption | 查询当前系统运行状态，可用于周期性监控。 |
| 系统状态 | GET | /dashboard/current/node | 查询当前节点运行状态。 |
| 系统状态 | GET | /dashboard/current/top/cpu | 查询 CPU 占用最高的进程。 |
| 系统状态 | GET | /dashboard/current/top/mem | 查询内存占用最高的进程。 |
| 硬件监控 | GET | /ai/gpu/load | 查询 GPU / XPU 设备和运行信息。 |
| 硬件监控 | POST | /hosts/monitor/search | 查询 CPU、内存、磁盘、网络、IO 等历史监控数据。 |
| 硬件监控 | POST | /hosts/monitor/gpu/search | 查询 GPU 历史监控数据。 |
| 硬件监控 | POST | /toolbox/device/base | 查询设备基础硬件信息。 |
示例中的签名头请以实际面板 API Key 规则为准，不要把密钥写入浏览器前端、公开仓库或日志。
curl -X GET "https://your-duize.example.com/api/v2/dashboard/base/os" \
-H "Duize-Token: ${DUIZE_TOKEN}" \
-H "Timestamp: ${DUIZE_TIMESTAMP}"curl -X POST "https://your-duize.example.com/api/v2/hosts/monitor/search" \
-H "Content-Type: application/json" \
-H "Duize-Token: ${DUIZE_TOKEN}" \
-H "Timestamp: ${DUIZE_TIMESTAMP}" \
-d '{
"param": "cpu",
"info": "all",
"startTime": "2026-05-31 00:00:00",
"endTime": "2026-05-31 23:59:59"
}'| 对接环节 | 继续阅读 | 验收重点 |
|---|---|---|
| Token 与白名单 | API 接口与外部系统对接 | Token 权限最小化，来源 IP 受控。 |
| AI 工具调用 | 管理员 AI 审计 | 高风险动作有审批和审计记录。 |
| 凭据管理 | 凭据保险箱 | 密钥不写入普通聊天、脚本或公开文档。 |