AI 助理
备案控制台
开发者社区> 问答> 正文

关于Bucket的操作之如何实现GetBucket？


Get Bucket (List Object)


Get Bucket操作可用来list Bucket中所有Object的信息。

请求语法GET / HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue



请求参数(Request Parameters)


GetBucket（ListObject）时，可以通过prefix，marker，delimiter和max-keys对list做限定，返回部分结果。另外，可以通过encoding-type对返回结果中的Delimiter、Marker、Prefix、NextMarker和Key这些元素进行编码。

名称描述
delimiter是一个用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现delimiter字符之间的object作为一组元素——CommonPrefixes。数据类型：字符串默认值：无
marker设定结果从marker之后按字母排序的第一个开始返回。数据类型：字符串默认值：无
max-keys限定此次返回object的最大数，如果不设定，默认为100，max-keys取值不能大于1000。数据类型：字符串默认值：100
prefix限定返回的object key必须以prefix作为前缀。注意使用prefix查询时，返回的key中仍会包含prefix。数据类型：字符串默认值：无
encoding-type指定对返回的内容进行编码，指定编码的类型。Delimiter、Marker、Prefix、NextMarker和Key使用UTF-8字符，但xml 1.0标准不支持解析一些控制字符，比如ascii值从0到10的字符。对于包含xml 1.0标准不支持的控制字符，可以通过指定encoding-type对返回的Delimiter、Marker、Prefix、NextMarker和Key进行编码。数据类型：字符串默认值：无，可选值：url


响应元素(Response Elements)

名称描述
Contents保存每个返回Object meta的容器。类型：容器父节点：ListBucketResult
CommonPrefixes如果请求中指定了delimiter参数，则在OSS返回的响应中包含CommonPrefixes元素。该元素标明那些以delimiter结尾，并有共同前缀的object名称的集合。类型：字符串父节点：ListBucketResult
Delimiter是一个用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现delimiter字符之间的object作为一组元素——CommonPrefixes。类型：字符串父节点：ListBucketResult
EncodingType指明返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，那会对返回结果中的Delimiter、Marker、Prefix、NextMarker和Key这些元素进行编码。类型：字符串父节点：ListBucketResult
DisplayNameObject 拥有者的名字。类型：字符串父节点：ListBucketResult.Contents.Owner
ETagETag (entity tag) 在每个Object生成的时候被创建，用于标示一个Object的内容。对于Put Object请求创建的Object，ETag值是其内容的MD5值；对于其他方式创建的Object，ETag值是其内容的UUID。ETag值可以用于检查Object内容是否发生变化。不建议用户使用ETag来作为Object内容的MD5校验数据完整性。类型：字符串父节点：ListBucketResult.Contents
IDBucket拥有者的用户ID。类型：字符串父节点：ListBucketResult.Contents.Owner
IsTruncated指明是否所有的结果都已经返回； “true”表示本次没有返回全部结果；“false”表示本次已经返回了全部结果。类型：枚举字符串有效值：true、false父节点：ListBucketResult
KeyObject的Key.类型：字符串父节点：ListBucketResult.Contents
LastModifiedObject最后被修改的时间。类型：时间父节点：ListBucketResult.Contents
ListBucketResult保存Get Bucket请求结果的容器.类型：容器 子节点：Name, Prefix, Marker, MaxKeys, Delimiter, IsTruncated, Nextmarker, Contents父节点：None
Marker标明这次Get Bucket（List Object）的起点。类型：字符串父节点：ListBucketResult
MaxKeys响应请求内返回结果的最大数目。类型：字符串父节点：ListBucketResult
NameBucket名字类型：字符串父节点：ListBucketResult
Owner保存Bucket拥有者信息的容器。类型：容器 子节点：DisplayName, ID父节点：ListBucketResult
Prefix本次查询结果的开始前缀。类型：字符串父节点：ListBucketResult
SizeObject的字节数。类型：字符串父节点：ListBucketResult.Contents
StorageClassObject的存储类型，支持“Standard”、“IA”、“Archive”。（目前只有部分区域支持“Archive”类型）类型：字符串父节点：ListBucketResult.Contents


细节分析

  1. Object中用户自定义的meta，在GetBucket请求时不会返回。
  2. 如果访问的Bucket不存在，包括试图访问因为命名不规范无法创建的Bucket，返回404 Not Found错误，错误码：NoSuchBucket。
  3. 如果没有访问该Bucket的权限，返回403 Forbidden错误，错误码：AccessDenied。
  4. 如果因为max-keys的设定无法一次完成listing，返回结果会附加一个<NextMarker>，提示继续listing可以以此为marker。NextMarker中的值仍在list结果之中。
  5. 在做条件查询时，即使marker实际在列表中不存在，返回也从符合marker字母排序的下一个开始打印。如果max-keys小于0或者大于1000，将返回400 Bad Request错误。错误码：InvalidArgument。
  6. 若prefix，marker，delimiter参数不符合长度要求，返回400 Bad Request。错误码：InvalidArgument。
  7. prefix，marker用来实现分页显示效果，参数的长度必须小于1024字节。
  8. 如果把prefix设为某个文件夹名，就可以罗列以此prefix开头的文件，即该文件夹下递归的所有的文件和子文件夹。如果再把delimiter设置为 / 时，返回值就只罗列该文件夹下的文件，该文件夹下的子文件名返回在CommonPrefixes部分，子文件夹下递归的文件和文件夹不被显示。如一个bucket存在三个object :fun/test.jpg， fun/movie/001.avi， fun/movie/007.avi。若设定prefix为”fun/” ，则返回三个object；如果增加设定delimiter为“/”，则返回文件”fun/test.jpg”和前缀”fun/movie/”；即实现了文件夹的逻辑。


举例场景


在bucket“my_oss”内有4个object，名字分别为：
  • oss.jpg
  • fun/test.jpg
  • fun/movie/001.avi
  • fun/movie/007.avi


示例


[backcolor=transparent]请求示例： GET / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 24 Feb 2012 08:43:27 GMT
Authorization: OSS qn6qrrqxo2oawuk53otfj byc:BC+oQIXVR2/ZghT7cGa0ykboO4M=

[backcolor=transparent]返回示例： HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906008B
Date: Fri, 24 Feb 2012 08:43:27 GMT
Content-Type: application/xml
Content-Length: 1866
Connection: keep-alive
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns=”http://doc.oss-cn-hangzhou.aliyuncs.com”>
<Name>oss-example</Name>
<Prefix></Prefix>
<Marker></Marker>
<MaxKeys>100</MaxKeys>
<Delimiter></Delimiter>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>fun/movie/001.avi</Key>
        <LastModified>2012-02-24T08:43:07.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user-example</DisplayName>
        </Owner>
    </Contents>
    <Contents>
        <Key>fun/movie/007.avi</Key>
        <LastModified>2012-02-24T08:43:27.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user-example</DisplayName>
        </Owner>
    </Contents>
<Contents>
        <Key>fun/test.jpg</Key>
        <LastModified>2012-02-24T08:42:32.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user-example</DisplayName>
        </Owner>
    </Contents>
    <Contents>
        <Key>oss.jpg</Key>
        <LastModified>2012-02-24T06:07:48.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user-example</DisplayName>
        </Owner>
    </Contents>
</ListBucketResult>

[backcolor=transparent]请求示例(含Prefix参数)： GET /?prefix=fun HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 24 Feb 2012 08:43:27 GMT
Authorization: OSS qn6qrrqxo2oawuk53otfj byc:BC+oQIXVR2/ZghT7cGa0ykboO4M=

[backcolor=transparent]返回示例： HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906008B
Date: Fri, 24 Feb 2012 08:43:27 GMT
Content-Type: application/xml
Content-Length: 1464
Connection: keep-alive
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns=”http://doc.oss-cn-hangzhou.aliyuncs.com”>
<Name>oss-example</Name>
<Prefix>fun</Prefix>
<Marker></Marker>
<MaxKeys>100</MaxKeys>
<Delimiter></Delimiter>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>fun/movie/001.avi</Key>
        <LastModified>2012-02-24T08:43:07.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user_example</DisplayName>
        </Owner>
    </Contents>
    <Contents>
        <Key>fun/movie/007.avi</Key>
        <LastModified>2012-02-24T08:43:27.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user_example</DisplayName>
        </Owner>
    </Contents>
    <Contents>
        <Key>fun/test.jpg</Key>
        <LastModified>2012-02-24T08:42:32.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user_example</DisplayName>
        </Owner>
    </Contents>
</ListBucketResult>

[backcolor=transparent]请求示例(含prefix和delimiter参数)： GET /?prefix=fun/&delimiter=/ HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 24 Feb 2012 08:43:27 GMT
Authorization: OSS qn6qrrqxo2oawuk53otfj byc:DNrnx7xHk3sgysx7I8U9I9IY1vY=

[backcolor=transparent]返回示例： HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906008B
Date: Fri, 24 Feb 2012 08:43:27 GMT
Content-Type: application/xml
Content-Length: 712
Connection: keep-alive
Server: AliyunOSS
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns=”http://doc.oss-cn-hangzhou.aliyuncs.com”>
<Name>oss-example</Name>
<Prefix>fun/</Prefix>
<Marker></Marker>
<MaxKeys>100</MaxKeys>
<Delimiter>/</Delimiter>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>fun/test.jpg</Key>
        <LastModified>2012-02-24T08:42:32.000Z</LastModified>
        <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE"</ETag>
        <Type>Normal</Type>
        <Size>344606</Size>
        <StorageClass>Standard</StorageClass>
        <Owner>
            <ID>00220120222</ID>
            <DisplayName>user_example</DisplayName>
        </Owner>
    </Contents>
   <CommonPrefixes>
        <Prefix>fun/movie/</Prefix>
   </CommonPrefixes>
</ListBucketResult>

展开
收起
青衫无名 2017-10-20 10:43:46 4877 0
0 条回答
写回答
取消 提交回答
问答分类：
XML 存储 对象存储 数据格式 容器 对象存储 云解析DNS
问答地址：
开发者社区 > 云计算 > 问答

版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

相关问答
OSS分片上传，对同一个bucketName, key进行多次请求uploadId，会有什么影响？
821
0
0
关于Bucket的操作之如何实现PutBucketLifecycle？
1977
0
0
关于Bucket的操作之如何实现PutBucket？
2161
0
0
关于Bucket的操作之如何实现 GetBucketReferer？
1912
0
0
关于Bucket的操作之如何实现GetBucketLogging？
1719
0
0
关于Bucket的操作之如何实现 PutBucketReferer？
2164
0
0
关于Bucket的操作之如何实现 PutBucketACL？
2460
0
0
关于Bucket的操作之如何实现GetBucketLifecycle？
2112
1
0
关于Bucket的操作之如何实现 DeleteBucketLogging？
1963
0
0
关于Bucket的操作之如何实现GetBucketLocation？
1964
0
0
问答排行榜
最热
最新
1 【大咖问答】对话PostgreSQL 中国社区发起人之一，阿里云数据库高级专家 德哥 1819059
2 据说在家办公的程序员是这样写代码的？ 1793212
3 阿里云开放端口权限 690311
4 如何升级配置 536309
5 【藏经阁一起读（27）】本周推荐《Apache Flink案例集（2022版）》，你有哪些心得？ 522877
6 【精品问答】python技术1000问(1) 514141
7 Flink Forward Asia 2021 有奖问答 512921
8 OceanBase 使用动画（持续更新） 359386
9 阿里云LNAMP(Linux + Nginx + Apache + MySQL + PHP)环境一键安装脚本 329807
10 OSS存储服务-客户端工具 321605
11 为体验实验室取一个新名字。 307494
12 企业邮箱发送邮件时，若出现投递失败产生退信，内容提示包含如下： the mta server of * reply:550 failed to meet SPF requirements 或者 the mta server of 163.com — 163mx01.mxmail.netease.com(220.181.14.141) reply:550 MI:SPF mx14,QMCowECpA0qTiftVaeB3Cg—.872S2 1442548128 http://mail.163.com/help 304110
13 Win Server 2003-2016 加密勒索事件必打补丁合集 295338
14 FLASH播放器，在IE浏览器下显示请确定您的域名已完成备案和CNAME绑定 284223
15 安全组详解，新手必看教程 277351
16 写code还是做管理，开发者如何进行职业规划？ 269202
17 惊喜翻倍：免费ECS+免费环境配置~！(ECS免费体验6个月活动3月31日结束) 255886
18 阿里云手机和阿云浏览器连接问题专帖 235697
19 支付宝H5 下载的时候，提示 【请确保该下载文件来源安全,如需浏览,请长按网址复制后使用浏览器访问】 229269
20 请问阿里云邮箱如何开启SMTP服务啊！ 225879
1 AI 编码助手能否引领编程革命？一起探索 AI 对研发流程的变革 261
2 AI新茶饮，是噱头还是未来？ 654
3 开发者们需要如何打造属于自己的Plan B? 343
4 动机VS自律，对开发者们来说哪个比较重要？ 455
5 AI音色克隆挑战播客，它能模拟人的特质吗？ 977
6 阿里云RDS mysql数据库show slave status信息疑问 347
7 求助：宜搭如何在请求数据源时传入参数 101
8 宜搭报表对日期字段赋值 243
9 求助：如何在宜搭自定义表单中获取普通表单子表单中的数据 167
10 AI生成海报or人工手绘，哪个更戳你？ 2174
11 “AI +脱口秀”，笑点能靠算法去创造吗？ 1053
12 宜搭配置更新花名册信息的连接器 229
13 请教：通过按钮打开另外一个表单，并把其中一个值传递给另一个表单的其中一个字段。 435
14 AI宠物更适合当代年轻人的陪伴需求吗？ 1389
15 AI客服未来会完全代替人工吗？ 1744
16 modelscope下载 的模型 如何转ollama 437
17 关于宜搭自定义页面循环数据渲染的问题。 110
18 “云+AI”能够孵化出多少可能？ 1262
19 当AI频繁生成虚假信息，我们还能轻信大模型吗？ 1197
20 使用免费证书后 服务器浏览器访问没有问题，外网访问 显示证书不可信，使用同一种浏览器哦 439
推荐问答
乘风问答官招募中！机械键盘免费拿

相关文章

  • 硬盘数据恢复——硬盘固件区损坏的数据恢复方案
  • 管理者必看：重新定义文档协作的时代
  • ORM 技术的终结者
  • 用于 syslog 收集的协议：TCP、UDP、RELP
  • 协作的未来已来：文档管理的核心地位正在上升

    • 相关电子书

    更多
    • Phoenix 全局索引原理与实践 立即下载
    低代码开发师（初级）实战教程 立即下载
    阿里巴巴DevOps 最佳实践手册 立即下载

    相关实验场景

    更多
  • 使用Count功能批量创建资源
    152
    1.0小时
    去实验