核心用法
synology-dsm 技能通过封装 Synology DSM Web API,使用 curl 命令与群晖 NAS 进行交互。主要功能模块包括:
- 认证管理:支持标准登录/登出,自动处理 2FA 双因素认证,会话 ID(SID)有效期约 15 分钟
- FileStation 文件管理:共享文件夹浏览、文件列表、创建/重命名/删除文件夹、文件上传下载、异步搜索
- DownloadStation 下载管理:支持 HTTP/FTP/BT 磁力链接及种子文件添加,任务暂停/恢复/删除,实时传输速率监控
- 系统信息查询:获取 DSM 版本、硬件型号、存储卷状态、网络配置等核心指标
显著优点
1. 官方 API 底层实现:直接调用群晖原生 Web API,非第三方逆向方案,接口稳定性有保障
2. 功能覆盖全面:涵盖日常 NAS 管理 90% 以上高频场景,从文件整理到下载自动化均可实现
3. 环境变量安全设计:强制使用 $SYNOLOGY_PASS 变量引用,避免凭证硬编码泄露
4. 完善的错误码体系:内置 10+ 类常见错误处理指引(会话超时、权限不足、2FA 等)
潜在缺点与局限
- 会话管理门槛:需手动维护 SID 状态,15 分钟超时后需重新认证,不适合长时无人值守任务
- HTTP 明文风险:默认示例使用 HTTP(5000 端口),实际生产环境需强制 HTTPS 并自行配置证书信任
- 功能边界限制:不支持 DSM 7.0+ 部分新特性(如 Synology Drive 团队文件夹),不包含硬件级操作(关机/重启)
- 依赖网络可达性:需 NAS 与执行端处于同一网络或已配置端口转发/VPN
适合人群
- 家庭 NAS 用户需要批量文件整理、自动下载管理
- 运维人员编写轻量级监控脚本检查存储空间/系统健康度
- 开发者快速原型验证群晖 API 调用逻辑
常规风险
- 凭证泄露:环境变量在进程内可见,多用户系统需配合
.env文件权限控制(600 模式) - 误操作不可逆:FileStation 删除默认不经过回收站,批量删除前建议先
getinfo确认路径 - API 版本漂移:群晖 DSM 升级可能废弃旧版 API,需关注
SYNO.API.Info返回的可用版本范围