Skip to main content

通用说明

认证方式

文件管理接口需携带 Cookie(含 userNameTMSESSNAME)和请求头 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
}
字段类型说明
codeboolean请求是否成功,true=成功,false=失败
code_numinteger业务状态码,0=成功,非0=错误
code_msgstring业务错误码对应的描述信息
msgstring错误响应消息,成功时为空字符串
dataobject/array返回的数据内容
is_loginboolean用户登录状态,true=已登录
timenumber服务器处理耗时(秒)

错误码说明

以下为文件管理接口可能返回的业务错误码:

code_numcode_msg说明
0OK请求成功
21invalid argument参数不合法
24missing session缺少会话凭证
27account has been disabled账号已被禁用
33not empty资源非空,无法执行操作
34source path can not be used源路径不可用
35source path already exist源路径已存在
90permission denied权限不足
104path does not exist路径不存在
117please login请先登录
118name already exists名称已存在
126Read-only file system文件系统只读