接口描述:

  • 获取资源列表。

请求 URL:

  • http|https://host/api/v1/storage/method/get.storage.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
storage_id integer egt:0 0 2 资源编号 0=全部
name string max:255 //cover.jpg 资源名称
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc asc desc 排序方式
order_field string 见附属 A storage_id create_time 排序字段

附属 A:
in:storage_id,name,type,create_time,update_time

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 2 合计计数
items 类型 是否返回 示例值 描述
storage_id integer 51 资源编号
parent_id integer 0 所属资源编号
name string 3a220004b7106964.png 资源名称
mime string image/png 资源Mime
ext string png 资源后缀
size string 40295 资源大小
pixel array ["width":855,"height":419] 资源像素,非图片资源则为空
hash string …(太长省略) 资源Hash值
path string …(太长省略) 资源内部路径(资源标识)
url string …(太长省略) 资源外链地址
protocol string aliyun 资源协议(模块名)
type integer 0 资源类型 0=图片 1=附件 2=目录
cover string //cover.jpg 资源目录封面(只有目录才会有封面)
sort integer 50 排序值
create_time datetime 2018-05-28 23:20:31 创建时间
update_time datetime 2018-05-28 23:20:31 更新时间

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "storage_id": 56,
  8. "parent_id": 2,
  9. "name": "子子文件夹",
  10. "mime": "",
  11. "ext": "",
  12. "size": 0,
  13. "pixel": [],
  14. "hash": "",
  15. "path": "",
  16. "url": "",
  17. "protocol": "",
  18. "type": 2,
  19. "cover": "//cover.jpg",
  20. "sort": 50,
  21. "create_time": "2018-03-19 09:04:22",
  22. "update_time": "2018-05-29 10:40:20"
  23. },
  24. {
  25. "storage_id": 51,
  26. "parent_id": 2,
  27. "name": "3a220004b7106964.png",
  28. "mime": "image/png",
  29. "ext": "png",
  30. "size": 40295,
  31. "pixel": {
  32. "width": 855,
  33. "height": 419
  34. },
  35. "hash": "4D5336213F769F2FC3D93A57F2E3E4ED",
  36. "path": "uploads/files/20180528/3a220004b7106964.png",
  37. "url": "careyshop.oss-cn-hangzhou.aliyuncs.com/uploads/files/20180528/3a220004b7106964.png?type=aliyun",
  38. "protocol": "aliyun",
  39. "type": 0,
  40. "cover": "",
  41. "sort": 50,
  42. "create_time": "2018-05-28 23:20:31",
  43. "update_time": "2018-05-28 23:20:31"
  44. }
  45. ],
  46. "total_result": 2
  47. }
  48. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。

  2. 当参数storage_id的值大于0时表示获取指定资源目录下的列表。

  3. 资源目录就像系统文件夹,不会列出所有资源,而是一层一层进入。

文档更新时间: 2018-06-03 00:00