接口大师标准版演示 / 后台接口 / 获取文件列表

获取文件列表

接口描述: 获取文件列表

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
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

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2021-05-06 09:44:14