列举桶内对象ListObjects_桶的基础操作

华为云计算云知识列举桶内对象ListObjects

新客秒杀 2核2G 3M L实例

68元/年

普惠上云领千元上云礼券

立即前往

企业专享 X实例 4核8G 5M

888元/年

热门域名 1元随心购

1元/年起

列举桶内对象ListObjects

时间: 2023-08-15 11:43:02

API网关云服务器云主机云计算弹性伸缩

猜你想看：

实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

对桶拥有读权限的用户可以执行获取桶内对象列表的操作。

如果用户在请求的URI里只指定了桶名,即GET /BucketName,则返回信息中会包含桶内部分或所有对象的描述信息(一次最多返回1000个对象信息);如果用户还指定了prefix、marker、max-keys、delimiter参数中的一个或多个,则返回的对象列表将按照如表1所示规定的语义返回指定的对象。

URL

GET https://obs.cn-north-4.myhuaweicloud.com/

请求参数

名称	类型	IN	必选	描述
Authorization	string	header	是	请求消息中可带的签名信息。
Date	string	header	否	请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。默认值:无。条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。
bucket_name	string	query	是	请求的桶名称。
prefix	string	query	否	列举以指定的字符串prefix开头的对象。
marker	string	query	否	列举桶内对象列表时,指定一个标识符,从该标识符以后按字典顺序返回对象列表。
max-keys	integer	query	否	指定返回的最大对象数,返回的对象列表将是按照字典顺序的最多前max-keys个对象,范围是[1,1000],超出范围时,按照默认的1000进行处理。
delimiter	string	query	否	将对象名进行分组的分隔符。如果指定了prefix,从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefixes;如果没有指定prefix,从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组,形成一条CommonPrefixes。例如,桶中有3个对象,分别为abcd、abcde、bbcde。如果指定delimiter为d,prefix为a,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefixes;如果只指定delimiter为d,abcd、abcde会被分成一组,形成一条前缀为abcd的CommonPrefixes,而bbcde会被单独分成一组,形成一条前缀为bbcd的CommonPrefixes。
key-marker	string	query	否	列举对象时的起始位置。有效值:上次请求返回体的NextKeyMarker值
version-id-marker	string	query	否	本参数只适用于多版本例举场景与请求中的key-marker配合使用,返回的对象列表将是按照字典顺序排序后在该标识符以后的对象(单次返回最大为1000个)。如果version-id-marker不是key-marker对应的一个版本号,则该参数无效。有效值:对象的版本号,即上次请求返回体的NextVersionIdMarker值
encoding-type	string	query	否	对响应中的部分元素进行指定类型的编码。如果Delimiter、Marker(或KeyMarker)、Prefix、NextMarker(或NextKeyMarker)和Key包含xml 1.0标准不支持的控制字符,可通过设置encoding-type对响应中的Delimiter、Marker(或KeyMarker)、Prefix(包括CommonPrefixes中的Prefix)、NextMarker(或NextKeyMarker)和Key进行编码。可选值:url

返回参数

返回码: 200

成功响应消息

名称	类型	必选	描述
Content-Length	string	否	响应消息体的字节长度。
Connection	string	否	指明与服务器的连接是长连接还是短连接。
Date	string	否	OBS系统响应的时间。
ETag	string	否	对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。
x-obs-id-2	string	否	帮助定位问题的特殊符号。
x-obs-request-id	string	否	由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。
x-obs-bucket-type	string	否	通过此消息头明确获取的列表内容。取值: OBJECT:获取所有桶列表。 POSIX:获取所有并行文件系统列表。不带此消息头则获取所有桶和并行文件系统列表。

名称	类型	必选	描述
Contents	Contents object	否	对象的元数据信息。
CommonPrefix	string	否	请求中带delimiter参数时,返回消息带CommonPrefixes分组信息。
Delimiter	string	否	请求中携带的delimiter参数。
EncodingType	string	否	对响应中的部分元素进行指定类型的编码。如果请求中设置了encoding-type,那响应中的Delimiter、Marker、Prefix(包括CommonPrefixes中的Prefix)、NextMarker和Key会被编码。
IsTruncated	boolean	否	表明是否本次返回的ListBucketResult结果列表被截断。“true”表示本次没有返回全部结果;“false”表示本次已经返回了全部结果。
Marker	string	否	列举对象时的起始位置标识符。
NextMarker	string	否	如果本次没有返回全部结果,响应请求中将包含此字段,用于标明本次请求列举到的最后一个对象。后续请求可以指定Marker等于该值来列举剩余的对象。
MaxKeys	string	否	列举时最多返回的对象个数。
Name	string	否	本次请求的桶名。
Prefix	string	否	对象名的前缀,表示本次请求只列举对象名能匹配该前缀的所有对象。

200 Contents

名称	类型	必选	描述
Owner	Owner object	否	桶拥有者信息,包含租户ID。
ETag	string	否	对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。(当对象是服务端加密的对象时,ETag值不是对象的MD5值,而是通过服务端加密计算出的唯一标识。)
Type	string	否	对象类型,非Normal对象时返回。
Key	string	否	对象名。
LastModified	string	否	对象最近一次被修改的时间(UTC时间)。
Size	string	否	对象的字节数。
StorageClass	string	否	对象的存储类型。

200 Contents.Owner

名称	类型	必选	描述
ID	string	否	用户的DomainID(帐号ID)。

返回码: 400

请求失败响应消息。

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

请求示例

示例 1

"/"

"GET / HTTP/1.1\nUser-Agent: curl/7.29.0\nHost: examplebucket.obs.cn-north-4.myhuaweicloud.com\nAccept: */*\nDate: WED, 01 Jul 2015 02:28:25 GMT\nAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:KiyoYze4pmRNPYfmlXBfRTVxt8c=\n"

返回示例

返回码：200

成功响应消息

示例 1

HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016435D34E379ABD93320CB9 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAA BCS XiN7GPL/yXM6OSBaYCUV1zcY5OelWp Content-Type: application/xml Date: WED, 01 Jul 2015 02:23:30 GMT Content-Length: 586 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ListBucketResult xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <Name>examplebucket</Name> <Prefix/> <Marker/> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>object001</Key> <LastModified>2015-07-01T00:32:16.482Z</LastModified> <ETag>"2fa3bcaaec668adc5da177e67a122d7c"</ETag> <Size>12041</Size> <Owner> <ID>b4bf1b36d9ca43d984fbcb9491b6fce9</ID> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> </ListBucketResult>

错误码

请参考错误码说明。