get-bucket-objects

Get Bucket Objects

1. 描述

GET Bucket 接口返回 bucket 下的所有对象信息,可通过设置参数来筛选对象。

2. 请求地址

GET /{bucket}

3. 请求头

请求头信息请参考【公共参数】部分。

4. 请求参数

Name Type Description Required
prefix String 限定返回以prefix为前缀的对象
delimiter String 对object key进行分组的字符,将object key前缀与分隔符之间内容相同的作为同一个分组
marker String 上一个分页最后一个对象的key,作为下一个分页开始的标志
maxKeys Integer 单次返回对象的最大条目数,默认值为100

5. 响应头

该响应头信息请参考【公共参数】部分。

6. 响应体

Name Type Description
objectSummaries Object 保存返回结果的容器
delimiter List 请求中指定了delimiter,则会返回commonPrefixes,内容为文件夹信息
bucketName String bucket对象名
maxKeys Integer 值同请求参数中的maxKeys
delimiter String 对object名字进行分组的字符,前缀与分隔符之间内容相同相同的object将被分为一组,值同请求参数中的delimiter
truncated Boolean 如果所有结果已返回,值为false;若是部分返回,则为true

objectSummaries中的内容

Name Type Description
bucketName String bucket对象名
key String 对象的key
size Integer 对象的大小,单位为字节
lastModified Date 对象最近修改的时间
storageClass String Object的存储类型,目前返回的是STANDARD值
owner Entity 对象的所属者信息
etag String 对象的MD5哈希值

owner对象中的内容

Name Type Description
displayName String Bucket所属者名称
id String Bucket所属者Id

7. 请求示例

GET /bucket123?prefix=fun%2F&delimiter=%2F&maxKeys=5 HTTP/1.1
Date: Thu, 15 Nov 2018 13:27:48 GMT
Nonce: 5e72e157-f4e3-4180-9062-7c7127939faa
Authorization: YCS1-HMAC-SHA1 Credential=5adb2538-9333-4024-b757-e095fc609a84, SignedHeaders=date;nonce;version, Signature=5KmNSmZ7/vlWNti0cgNpJFiQNMY=
Version: 2018-10-30

8. 返回示例

{
 "objectSummaries": [
 {
  "bucketName": "bucket123",
  "key": "fun/test.jpg",
  "size": 0,
  "lastModified": 1534984830488,
  "storageClass": "STANDARD",
    "owner": {
       "displayName": "PRJ2",
       "id": "PRJ2"
      },
      "etag": "d41d8cd98f00b204e9800998ecf8427e"
     }
     ],
     "commonPrefixes": [
      "fun/doc/",
      "fun/movie/"
     ],
     "bucketName": "bucket-5",
     "prefix": "fun/",
     "maxKeys": 5,
     "delimiter": "/",
     "truncated": false
}

9. 错误码

该接口没有特殊错误码,错误码可以参考公共错误码

个结果匹配 ""

    无结果匹配 ""