通用说明
认证方式
文件管理接口需携带 Cookie(含 userName、TMSESSNAME)和请求头 X-Csrf-Token。
| 接口 | 认证要求 |
|---|---|
| 文件管理接口 | 需登录,需 CSRF Token |
DELETE /fileManage/folder/del | 需 Cookie,免 CSRF |
占位符说明:示例中
{ip}为 NAS 设备 IP 地址,{port}为 Web 服务端口(默认 5443)。
请求格式
- 数据格式:JSON,UTF-8
- GET 请求:参数通过 Query String 传递
- POST/DELETE 请求:参数通过 Request Body(JSON)传递
- 文件上传:
multipart/form-data
统一响应格式
{
"code": true,
"code_num": 0,
"code_msg": "",
"msg": "",
"data": {},
"is_login": true,
"time": 0.0
}
| 字段 | 类型 | 说明 |
|---|---|---|
| code | boolean | 请求是否成功,true=成功,false=失败 |
| code_num | integer | 业务状态码,0=成功,非0=错误 |
| code_msg | string | 业务错误码对应的描述信息 |
| msg | string | 错误响应消息,成功时为空字符串 |
| data | object/array | 返回的数据内容 |
| is_login | boolean | 用户登录状态,true=已登录 |
| time | number | 服务器处理耗时(秒) |
错误码说明
以下为文件管理接口可能返回的业务错误码:
| code_num | code_msg | 说明 |
|---|---|---|
| 0 | OK | 请求成功 |
| 21 | invalid argument | 参数不合法 |
| 24 | missing session | 缺少会话凭证 |
| 27 | account has been disabled | 账号已被禁用 |
| 33 | not empty | 资源非空,无法执行操作 |
| 34 | source path can not be used | 源路径不可用 |
| 35 | source path already exist | 源路径已存在 |
| 90 | permission denied | 权限不足 |
| 104 | path does not exist | 路径不存在 |
| 117 | please login | 请先登录 |
| 118 | name already exists | 名称已存在 |
| 126 | Read-only file system | 文件系统只读 |