列举资源(list)

描述

该接口提供在云存储平台分批列举指定空间内的资源。

请求说明

  GET /list?bucket=<bucket>&limit=<limit>&prefix=<Urlsafe_Base64_Encoded_Prefix>&mode=<mode>&marker=<marker>
  Host:<MgrDomain>
  Authorization:<AccessToken>

头部说明

参数 必填 描述
Host 管理域名,可在用户管理界面获取
Authorization 管理凭证

参数说明

参数 必填 描述
bucket 指定空间。
limit 列举条目数,范围1-1000。默认值为1000。
prefix 指定前缀,只有文件名匹配该前缀的资源才会被列举出来。默认为空。字符串需要经过URL安全的Base64编码
startTime 文件上传起始时间,格式为精确到毫秒的时间差,如1526745600000(2015/5/20 00:00:00)。
endTime 文件上传终止时间,格式为精确到毫秒的时间差,如1527609600000(2015/5/30 00:00:00)。
mode 指定列表排序方式:0代表优先列出目录下的文件;1代表优先列出目录下的文件夹。
不指定该参数时,即按照key排序列出目录下的所有文件及子目录下的文件。
marker 上次列举返回的位置标记,作为本次列举的起点信息。默认为空。

注:mode参数用于模拟文件系统。

  • 指定mode参数时,可以通过prefix参数指定查询的目录,此时prefix参数不支持模糊查询。
  • 未指定mode参数时,prefix参数支持模糊查询

响应说明

如果请求成功,则返回如下内容的Json串:

{
    "marker": "<marker string>",
    "commonPrefixes": [
        "xxx",
        "yyy"
    ],
    "items": [
        {
            "key":     "<key string>",
            "putTime":   <filePutTime long>,
            "hash":     "<fileETag string>",
            "fsize":     <fileSize string>,
            "mimeType": "<mimeType string>"
            "expirationDate":   "<expirationDate string>"
        },
        ...
    ]
}
字段名 必填 描述
marker 有剩余条目则返回非空字符串,作为下一次列举的参数传入。如果没有剩余条目则返回空字符串。
commonPrefixes 所有目录名的数组,如没有指定mode参数则该字段值为空。
items 所有返回条目的数组,如没有剩余条目则为空数组。
key 资源名。
putTime 上传时间,Unix格式,单位:毫秒。
fsize 资源内容的大小,单位:字节。
hash 资源内容的ETag值。
mimeType 资源内容的MIME类型。
expirationDate 文件过期时间,格式为YYYYMMDDhhmmss
注:文件过期后被清理的具体时间点以服务端任务执行为准,一天内的时间差属正常现象

如果请求失败,则返回如下内容的Json字符串:

{
    "code":     "<code string>",
    "message":  "<message string>"
}
字段名 必填 描述
code HTTP请求响应码,参见HTTP响应状态码<返回码>
message 列举资源失败的提示信息

范例

 curl -v -o filelist.json -H "Authorization:86622e227a50d49d858c2494a935bc2e4ac543a7:NTVjZWZmOThhYjUzMjhkMWQ3YzE3OGM0NTRhYzFmODc5MDQ0MWExNQ==" --url "http://mgrDomain/list?bucket=images&limit=10"