HTTP/HTTPS
请求协议
APIUSB / 后台接口 / 获取文件列表
获取文件列表
接口地址：https://api.apiusb.com/api/admin?s=Admin.File.GetList
接口描述： 获取文件列表
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| file_name | 字符串 | 可选 | - | 文件名，支持模糊匹配 | |
| sort | 枚举类型 | 可选 | id | 范围：file_name/file_size/file_type/upload_time/id | 排序字段 |
| by | 枚举类型 | 可选 | asc | 范围：asc/desc | 排序顺序，asc顺序，desc降序 |
| page | 整型 | 可选 | 1 | 最小：1 | 第几页 |
| perpage | 整型 | 可选 | 10 | 最小：1；最大：5000 | 分页数量 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.total | 整型 | 文件总数 |
| data.files | 字符串 | 文件列表 |
| data.files[].id | 整型 | ID |
| data.files[].file_name | 字符串 | 文件名称 |
| data.files[].file_type | 字符串 | 文件类型 |
| data.files[].file_size | 整型 | 文件大小，单位：B |
| data.files[].file_url | 字符串 | 文件路径 |
| data.files[].upload_time | 字符串 | 上传时间 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| file_name | 可选 | |
| sort | 可选 | |
| by | 可选 | |
| page | 可选 | |
| perpage | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Admin.File.GetList.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-10-16 09:13:21