本接口用于列举指定空间里的所有文件条目。
GET /list?bucket=<Bucket>&marker=<Marker>&limit=<Limit>&prefix=<UrlEncodedPrefix>&delimiter=<UrlEncodedDelimiter> HTTP/1.1
Host: rsf.qiniuapi.com
Content-Type: application/x-www-form-urlencoded
X-Qiniu-Date: 20060102T150405Z
Authorization: Qiniu <AccessToken>
| 参数名称 | 必填 | 说明 |
|---|---|---|
| bucket | 是 | 指定空间。 |
| marker | 否 | 上一次列举返回的位置标记,作为本次列举的起点信息。 默认值为空字符串。 |
| limit | 否 | 本次列举的条目数,范围为1-1000。 默认值为1000。 |
| prefix | 否 | 指定前缀,只有资源名匹配该前缀的资源会被列出。 默认值为空字符串。 |
| delimiter | 否 | 指定目录分隔符,列出所有公共前缀(模拟列出目录效果)。 默认值为空字符串。 |
| 头部名称 | 必填 | 说明 |
|---|---|---|
Authorization |
是 | 该参数应严格按照管理凭证格式进行填充,否则会返回401错误码 一个合法的Authorization值应类似于: |
| 其他 | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅公共请求头 |
该请求操作的请求体为空。
| 头部名称 | 必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 正常情况下该值将被设为 application/json,表示返回 JSON 格式的文本信息。 |
| 其他 | 该请求实现使用了所有操作的公共响应头。详细信息,请查阅公共响应头。 |
| 字段名称 | 必响应项目 | 说明 |
|---|---|---|
| marker | 是 | 起始条目标记,将作为下一次列举的参数传入。 如果没有剩余条目则返回空字符串。 |
| commonPrefixes | 是 | 返回目录名的数组,如没有指定delimiter参数则返回空。类型:数组 |
| items | 是 | 返回条目的数组。不能用来判断是否还有剩余条目。 类型:数组 |
| key | 是 | 资源名。 类型:字符串 |
| putTime | 是 | 上传时间,单位:100纳秒,其值去掉低七位即为Unix时间戳。 类型:数字 |
| lastModify | 是 | 文件修改时间,文件上传(含覆盖写)或修改元数据(含文件类型)、存储类型的时间。 类型:数字 |
| hash | 是 | 文件的HASH值,暨文件的七牛 ETag 值。类型:字符串 |
| fsize | 是 | 资源内容的大小,单位:字节。 类型:数字 |
| mimeType | 是 | 资源的 MIME 类型。 类型:字符串 |
| endUser | 否 | 资源内容的唯一属主标识,请参考上传策略 (PutPolicy)。 类型:字符串 |
| type | 是 | 资源的存储类型,0表示标准存储,1 表示低频存储,2 表示归档存储,3 表示深度归档存储,4 表示归档直读存储,5 表示智能分层存储。类型:数字 |
| status | 是 | 文件的存储状态,即禁用状态和启用状态间的的互相转换,0表示启用,1表示禁用,请参考:文件状态。类型:数字 |
| md5 | 否 | 文件md5值,32位16进制组成的字符串,只有通过直传文件和追加文件API上传的文件,服务端确保有该字段返回,如请求时服务端没有返回md5字段,可以通过请求qhash/md5 方法来获取,比如 http://test.com/test.mp4?qhash/md5 |
该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息,请查阅错误响应。
GET /list?bucket=test02&prefix=00 HTTP/1.1
Host: rsf.qiniuapi.com
User-Agent: Go-http-client/1.1
X-Qiniu-Date: 20171122T014120Z
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:XvRh0ABLViTohBkgKqa0upyiug0=
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip
注:要在Authorization头部的<AccessToken>前添加Qiniu和半角空格。
HTTP/1.1 200 OK
Content-Length: 739
Connection: keep-alive
Content-Type: application/json
Date: 2017年11月22日 01:41:20 GMT
Server: nginx
X-Reqid: QBUAAKUcoGrgRPkU
X-Reqid: QBUAAKUcoGrgRPkU
X-Reqid: QBUAAKUcoGrgRPkU.peer
{
"items": [
{
"key": "000001.pdf",
"hash": "Fs3oFOyOFDUp5CEODM8J6xquSq3s",
"fsize": 452584,
"mimeType": "application/pdf",
"putTime": 15112568720620784,
"md5": "e41714a18899cf59c200a9bddfa78b95",
"type": 0,
"status": 0
},
{
"key": "000002.ico",
"hash": "FpGrGHQOjETYnwxmSF3uXmFpmZIb",
"fsize": 5686,
"mimeType": "image/x-icon",
"putTime": 15112568850754920,
"type": 0,
"status": 0
},
{
"key": "000003.png",
"hash": "FreZ58OmkQe5ZRUktRsO3zoqRaHi",
"fsize": 21741,
"mimeType": "image/png",
"putTime": 15112568948976712,
"type": 0,
"status": 0
},
{
"key": "000004.png",
"hash": "FreZ58OmkQe5ZRUktRsO3zoqRaHi",
"fsize": 21741,
"mimeType": "image/png",
"putTime": 15112569033603324,
"type": 0,
"status": 0
}
]
}
GET /list?bucket=test02&prefix=00&limit=2 HTTP/1.1
Host: rsf.qiniuapi.com
User-Agent: Go-http-client/1.1
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:m-2lEHcnRVwgYBqJdC5SW7groT8=
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip
注:要在Authorization头部的<AccessToken>前添加Qiniu和半角空格。
HTTP/1.1 200 OK
Content-Length: 352
Connection: keep-alive
Content-Type: application/json
Date: 2017年11月22日 01:46:58 GMT
Server: nginx
X-Log: TBLMGR:10;UC:21;CFGG:22;RSF:90;RSF:92;ZONEPROXY:148
X-Reqid: pEYAABGkVfAuRfkU
X-Reqid: pEYAABGkVfAuRfkU
X-Reqid: pEYAABGkVfAuRfkU.peer
{
"marker": "eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9",
"items": [
{
"key": "000001.pdf",
"hash": "Fs3oFOyOFDUp5CEODM8J6xquSq3s",
"fsize": 452584,
"mimeType": "application/pdf",
"putTime": 15112568720620784,
"type": 0,
"status": 0
},
{
"key": "000002.ico",
"hash": "FpGrGHQOjETYnwxmSF3uXmFpmZIb",
"fsize": 5686,
"mimeType": "image/x-icon",
"putTime": 15112568850754920,
"type": 0,
"status": 0
}
]
}