文档首页/ OBS BrowserJS SDK/ API参考/ 桶相关接口/ 列举桶内对象
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

列举桶内对象

功能说明

列举桶内对象，默认返回最大1000个对象。

方法定义

ObsClient.listObjects

请求参数

字段名

类型

约束

说明

Bucket

String

必选

桶名。

RequestDate

String

或

Date

可选

指定请求时间。

说明：

当为String类型时，必须符合ISO8601或RFC822规范。

Prefix

String

可选

限定返回的对象名必须带有Prefix前缀。

Marker

String

可选

列举对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。

MaxKeys

Number

可选

列举对象的最大数目，取值范围为1~1000，当超出范围时，按照默认的1000进行处理。

Delimiter

String

可选

用于对对象名进行分组的字符。对于对象名中包含Delimiter的对象，其对象名（如果请求中指定了Prefix，则此处的对象名需要去掉Prefix）中从首字符至第一个Delimiter之间的字符串将作为一个分组并作为CommonPrefix返回。

返回结果（InterfaceResult）

字段名

类型

说明

RequestId

String

OBS服务端返回的请求ID。

Location

String

桶的区域位置。

Bucket

String

桶名。

Delimiter

String

用于对对象名进行分组的字符，与请求中的该参数对应。

IsTruncated

String

表明本次请求是否返回了全部结果，“true”表示没有返回全部结果；“false”表示已返回了全部结果。

Prefix

String

对象名的前缀，与请求中的该参数对应。

Marker

String

列举对象的起始位置，与请求中的该参数对应。

NextMarker

String

下次列举对象时请求的起始位置。

MaxKeys

String

列举对象的最大数目，与请求中的该参数对应。

Contents

Array

对象列表。

-

ETag

String

对象的MD5值（当对象是服务端加密的对象时，etag值不是对象的MD5值）。

Size

String

对象的字节数。

Key

String

对象名。

LastModified

String

对象最近一次被修改的时间。

Owner

Object

对象的所有者。

-

ID

String

对象所有者的DomainId。

-

StorageClass

String

对象的存储类型。

-

Type

String

对象是否可被追加上传。

CommonPrefixes

Array

当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。

-

Prefix

String

按Delimiter分组后的对象名称前缀。

代码样例

obsClient.listObjects({
       Bucket : 'bucketname',
       Prefix : 'prefix',
       MaxKeys : 100
},function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     for(var j=0;j<result.InterfaceResult.Contents.length;j++){
                           console.log('Contents[' + j +  ']:');
                           console.log('Key-->' + result.InterfaceResult.Contents[j]['Key']);
                           console.log('LastModified-->' + result.InterfaceResult.Contents[j]['LastModified']);
                           console.log('ETag-->' + result.InterfaceResult.Contents[j]['ETag']);
                           console.log('Size-->' + result.InterfaceResult.Contents[j]['Size']);
                           console.log('Owner[ID]-->' + result.InterfaceResult.Contents[j]['Owner']['ID']);
                           console.log('StorageClass-->' + result.InterfaceResult.Contents[j]['StorageClass']);
                     }
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});
父主题： 桶相关接口

相关文档