token获取

POST /api/auth/login

请求参数

名称 位置 类型 必选 说明
Password query string 密码
Username query string 用户名

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data object true none data
token string true none token

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "token": "abcd"
  }
}

获取文件列表

POST /api/fs/list

请求参数

名称 位置 类型 必选 说明
Authorization header string 用户token
Content-Type header string none
body body object none
page body integer 当前页数
password body string 密码
path body string 路径
per_page body integer 每页文件数
refresh body boolean 强制刷新

返回数据结构

名称 类型 必选 约束 中文名 说明
» code integer true none 状态码
» message string true none 信息
» data object true none none
»» content [object] true none none
»»» name string true none 文件名
»»» size integer true none 文件大小
»»» is_dir boolean true none 是否为目录
»»» modified string true none 修改时间
»»» sign string true none 访问密钥
»»» thumb string true none 缩略图地址
»»» type integer true none none
»» total integer true none 总文件数
»» readme string true none none
»» write boolean true none 写入权限
»» provider string true none 存储类型

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "name": "201311",
        "size": 0,
        "is_dir": true,
        "modified": "2021-11-30T15:41:43.004Z",
        "sign": "",
        "thumb": "",
        "type": 1
      },
      {
        "name": "201312",
        "size": 0,
        "is_dir": true,
        "modified": "2021-11-30T15:42:26.839Z",
        "sign": "",
        "thumb": "",
        "type": 1
      },
      {
        "name": "201401",
        "size": 0,
        "is_dir": true,
        "modified": "2021-11-30T15:42:37.344Z",
        "sign": "",
        "thumb": "",
        "type": 1
      },
      {
        "name": "201402",
        "size": 0,
        "is_dir": true,
        "modified": "2021-11-30T15:41:35.053Z",
        "sign": "",
        "thumb": "",
        "type": 1
      },
      {
        "name": "201403",
        "size": 0,
        "is_dir": true,
        "modified": "2021-11-30T15:41:51.271Z",
        "sign": "",
        "thumb": "",
        "type": 1
      }
    ],
    "total": 77,
    "readme": "",
    "write": true,
    "provider": "Aliyundrive"
  }
}

新建文件夹

POST /api/fs/mkdir

请求参数

名称 位置 类型 必选 说明
Authorization header string token
Content-Type header string none
body body object none
path body string 新目录路径

返回数据结构

|名称|类型|必选|约束|中文名|说明|
| :---: | :---: | :---: | :---: | :---: |
|code|integer|true|none||状态码|
|message|string|true|none||信息|
|data|null|true|none||data|

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

重命名文件夹

POST /api/fs/rename

请求参数

名称 位置 类型 必选 说明
Authorization header string token
Content-Type header string none
body body object none
name body string 目标目录名,不支持’/’
path body string 源目录名

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

删除文件夹

POST /api/fs/remove

请求参数

名称 位置 类型 必选 说明
Authorization header string token
Content-Type header string none
body body object none
dir body string 文件所在目录
names body [string] 文件名列表

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

PUT 表单上传文件

PUT /api/fs/form

请求参数

名称 位置 类型 必选 说明
Authorization header string token
Content-Type header string 需要是multipart/form-data;
Content-Length header string 文件大小
file-path header string 经过URL编码的完整文件路径
body body object none
file body string(binary) 文件

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

获取下载信息

POST /api/fs/get

请求参数

名称 位置 类型 必选 说明
Authorization header string token
Content-Type header string none
body body object none
password body string 密码
path body string 文件路径

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data object true none data
name string true none 文件名
size integer true none 文件大小
is_dir boolean true none 是否是目录
modified string true none 修改时间
sign string true none 文件密钥
thumb string true none 缩略图地址
type integer true none 类型
raw_url string true none 源文件下载地址
readme string true none none
provider string true none 驱动类型
related null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "name": "sw.jpg",
    "size": 169918,
    "is_dir": false,
    "modified": "2022-11-26T12:54:54.534Z",
    "sign": "xxxx",
    "thumb": "",
    "type": 5,
    "raw_url": "https://cn-beijing-data.aliyundrive.net/xxxx",
    "readme": "",
    "provider": "Aliyundrive",
    "related": null
  }
}

系统设置

GET /api/admin/setting/list

请求参数

名称 位置 类型 必选 说明
group query integer 0-站点;1-样式;2-预览;3-全局;4-令牌;5-aria2
Authorization header string token
Content-Type header string none

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data [object] true none none
key string true none
value string true none
help string true none none
type string true none 类型
options string true none none
group integer true none none
flag integer true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "key": "version",
      "value": "v3.5.1",
      "help": "",
      "type": "string",
      "options": "",
      "group": 0,
      "flag": 2
    },
    {
      "key": "site_title",
      "value": "",
      "help": "",
      "type": "string",
      "options": "",
      "group": 0,
      "flag": 0
    },
    {
      "key": "announcement",
      "value": "",
      "help": "",
      "type": "text",
      "options": "",
      "group": 0,
      "flag": 0
    },
    {
      "key": "pagination_type",
      "value": "pagination",
      "help": "",
      "type": "select",
      "options": "all,pagination,load_more,auto_load_more",
      "group": 0,
      "flag": 0
    },
    {
      "key": "default_page_size",
      "value": "30",
      "help": "",
      "type": "number",
      "options": "",
      "group": 0,
      "flag": 0
    }
  ]
}

账户列表

GET /api/admin/user/list

请求参数

名称 位置 类型 必选 说明
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none
content [object] true none none
id integer true none id
username string true none 用户名
password string true none 密码
base_path string true none 目录
role integer true none none
permission integer true none 权限
total integer true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": 1,
        "username": "admin",
        "password": "",
        "base_path": "/",
        "role": 2,
        "permission": 0
      },
      {
        "id": 2,
        "username": "guest",
        "password": "",
        "base_path": "/",
        "role": 1,
        "permission": 0
      }
    ],
    "total": 2
  }
}

存储列表

GET /api/admin/storage/list

请求参数

名称 位置 类型 必选 说明
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none
content [object] true none none
id integer false none id
mount_path string false none 挂载路径
order integer false none 顺序
driver string false none 驱动类型
cache_expiration integer false none 缓存时间
status string false none 状态
addition string false none 额外信息
remark string false none 备注名
modified string false none 修改时间
disabled boolean false none 是否被禁用
order_by string false none 排序方式
order_direction string false none 排序方向
extract_folder string false none 提取目录顺序
web_proxy boolean false none http代理
webdav_policy string false none webdav策略
down_proxy_url string false none 下载代理url
total integer true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": 1,
        "mount_path": "/阿里云盘",
        "order": 0,
        "driver": "Aliyundrive",
        "cache_expiration": 30,
        "status": "work",
        "addition": "{\"root_folder_id\":\"xxx\",\"refresh_token\":\"xxx\",\"order_by\":\"name\",\"order_direction\":\"ASC\",\"rapid_upload\":false}",
        "remark": "",
        "modified": "2022-11-26T18:55:55.261579727+08:00",
        "disabled": false,
        "order_by": "",
        "order_direction": "",
        "extract_folder": "",
        "web_proxy": false,
        "webdav_policy": "302_redirect",
        "down_proxy_url": ""
      }
    ],
    "total": 1
  }
}

启用存储

POST /api/admin/storage/enable

请求参数

名称 位置 类型 必选 说明
id query integer 存储id
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

禁用存储

POST /api/admin/storage/disable

请求参数

名称 位置 类型 必选 说明
id query string 存储id
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}

新建存储

POST /api/admin/storage/create

请求参数

名称 位置 类型 必选 说明
Authorization header string token
body body object none
mount_path body string 挂载路径
order body integer 排序
remark body string 备注名
cache_expiration body integer 缓存过期时间
web_proxy body boolean web代理
webdav_policy body string webdav策略
down_proxy_url body string 下载代理
extract_folder body string 提取目录
driver body string 驱动
addition body string 额外信息

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none
id integer true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "id": 2
  }
}

查询指定存储信息

GET /api/admin/storage/get

请求参数

名称 位置 类型 必选 说明
id query string 存储id
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none
id integer true none id
mount_path string true none 挂载路径
order integer true none 排序
driver string true none 驱动
cache_expiration integer true none 缓存过期时间
status string true none 状态
addition string true none 额外信息
remark string true none 备注
modified string true none 修改时间
disabled boolean true none 是否被禁用
order_by string true none 排序方式
order_direction string true none 排序方向
extract_folder string true none 提取目录
web_proxy boolean true none web代理
webdav_policy string true none webdav策略
down_proxy_url string true none 下载代理

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "id": 2,
    "mount_path": "/阿里云盘2",
    "order": 1,
    "driver": "Aliyundrive",
    "cache_expiration": 30,
    "status": "work",
    "addition": "{\"root_folder_id\":\"\",\"refresh_token\":\"\",\"order_by\":\"size\",\"order_direction\":\"ASC\",\"rapid_upload\":false}",
    "remark": "",
    "modified": "2022-11-26T21:50:44.142348853+08:00",
    "disabled": false,
    "order_by": "",
    "order_direction": "",
    "extract_folder": "front",
    "web_proxy": false,
    "webdav_policy": "302_redirect",
    "down_proxy_url": ""
  }
}

查询所有驱动配置模板列表

GET /api/admin/driver/list

请求参数

名称 位置 类型 必选 说明
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none
common [object] true none none
name string true none none
type string true none none
default string true none none
options string true none none
required boolean true none none
help string true none none
additional [object] true none none
name string true none none
type string true none none
default string true none none
options string true none none
required boolean true none none
help string true none none
config object true none none
name string true none none
local_sort boolean true none none
only_local boolean true none none
only_proxy boolean true none none
no_cache boolean true none none
no_upload boolean true none none
need_ms boolean true none none
default_root string true none none
CheckStatus boolean true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "115 Cloud": {
      "common": [
        {
          "name": "mount_path",
          "type": "string",
          "default": "",
          "options": "",
          "required": true,
          "help": ""
        },
        {
          "name": "order",
          "type": "number",
          "default": "",
          "options": "",
          "required": false,
          "help": "use to sort"
        },
        {
          "name": "remark",
          "type": "text",
          "default": "",
          "options": "",
          "required": false,
          "help": ""
        },
        {
          "name": "cache_expiration",
          "type": "number",
          "default": "30",
          "options": "",
          "required": true,
          "help": "The cache expiration time for this storage"
        },
        {
          "name": "webdav_policy",
          "type": "select",
          "default": "native_proxy",
          "options": "use_proxy_url,native_proxy",
          "required": true,
          "help": ""
        },
        {
          "name": "down_proxy_url",
          "type": "text",
          "default": "",
          "options": "",
          "required": false,
          "help": ""
        },
        {
          "name": "extract_folder",
          "type": "select",
          "default": "",
          "options": "front,back",
          "required": false,
          "help": ""
        }
      ],
      "additional": [
        {
          "name": "cookie",
          "type": "string",
          "default": "",
          "options": "",
          "required": false,
          "help": ""
        },
        {
          "name": "qrcode_token",
          "type": "string",
          "default": "",
          "options": "",
          "required": false,
          "help": ""
        },
        {
          "name": "root_folder_id",
          "type": "string",
          "default": "0",
          "options": "",
          "required": true,
          "help": ""
        }
      ],
      "config": {
        "name": "115 Cloud",
        "local_sort": false,
        "only_local": true,
        "only_proxy": true,
        "no_cache": false,
        "no_upload": false,
        "need_ms": false,
        "default_root": "0",
        "CheckStatus": false
      }
    }
  }
}

删除指定存储

POST /api/admin/storage/delete

请求参数

名称 位置 类型 必选 说明
id query string 存储id
Authorization header string token

返回数据结构

名称 类型 必选 约束 中文名 说明
code integer true none 状态码
message string true none 信息
data null true none none

返回示例

{
  "code": 200,
  "message": "success",
  "data": null
}
最后修改:2023 年 06 月 21 日
如果觉得我的文章对你有用,请随意赞赏