对象存储 > API 文档 > Object 接口 > 资源列举

资源列举

最近更新时间：2020-03-20 11:17:06

描述

本接口用于列举指定空间里的所有文件条目。

请求

语法

GET /list?bucket=<Bucket>&marker=<Marker>&limit=<Limit>&prefix=<UrlEncodedPrefix>&delimiter=<UrlEncodedDelimiter> HTTP/1.1
Host:           rsf.qbox.me
Content-Type:   application/x-www-form-urlencoded
Authorization:  Qiniu <AccessToken>

请求参数

参数名称	必填	说明
bucket	是	指定空间。
marker		上一次列举返回的位置标记，作为本次列举的起点信息。默认值为空字符串。
limit		本次列举的条目数，范围为1-1000。默认值为1000。
prefix		指定前缀，只有资源名匹配该前缀的资源会被列出。默认值为空字符串。
delimiter		指定目录分隔符，列出所有公共前缀（模拟列出目录效果）。默认值为空字符串。

请求头

该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅公共请求头。

请求元素

该请求操作的请求体为空。

响应

响应头

该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅公共响应头。

响应元素

字段名称	必响应项目	说明
marker		有剩余条目则返回非空字符串，作为下一次列举的参数传入。如果没有剩余条目则返回空字符串。类型：字符串
commonPrefixes		返回目录名的数组，如没有指定`delimiter`参数则不输出。类型：数组
items	是	返回条目的数组。不能用来判断是否还有剩余条目。类型：数组
key	是	资源名。类型：字符串
putTime	是	上传时间，单位：100纳秒，其值去掉低七位即为Unix时间戳。类型：数字
hash	是	文件的`HASH`值，使用hash值算法计算。类型：字符串
fsize	是	资源内容的大小，单位：字节。类型：数字
mimeType	是	资源的 MIME 类型。类型：字符串
endUser		资源内容的唯一属主标识，请参考上传策略 (PutPolicy)。类型：字符串
type		资源的存储类型，`2` 表示归档存储，`1` 表示低频存储，`0`表示标准存储。类型：数字
status	是	文件的存储状态，即禁用状态和启用状态间的的互相转换，`0`表示启用，`1`表示禁用，请参考：文件状态。类型：数字
md5	否	文件`md5`值，32位16进制组成的字符串，只有通过直传文件和追加文件API上传的文件，服务端确保有该字段返回，如请求时服务端没有返回md5字段，可以通过请求qhash/md5 方法来获取，比如 http://test.com/test.mp4?qhash/md5

特殊错误

该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅错误响应。

示例

列出所有 00 打头的资源

请求：
GET /list?bucket=test02&prefix=00 HTTP/1.1
Host: rsf.qbox.me
User-Agent: Go-http-client/1.1
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:XvRh0ABLViTohBkgKqa0upyiug0=
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip

响应：
HTTP/1.1 200 OK
Content-Length: 739
Connection: keep-alive
Content-Type: application/json
Date: Wed, 22 Nov 2017 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
    }
  ]
}

列出所有 00 打头的资源并每批 2 个

请求：
GET /list?bucket=test02&prefix=00&limit=2 HTTP/1.1
Host: rsf.qbox.me
User-Agent: Go-http-client/1.1
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:m-2lEHcnRVwgYBqJdC5SW7groT8=
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip

响应：
HTTP/1.1 200 OK
Content-Length: 352
Connection: keep-alive
Content-Type: application/json
Date: Wed, 22 Nov 2017 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
    }
  ]
}

以上内容是否对您有帮助？