对象存储服务 OBS-列举对象:返回结果

时间:2024-09-09 11:37:22

返回结果

表2 返回结果

参数类型

描述

表3

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见表3

表3 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

表5

参数解释:

操作成功后的结果数据,详见表5

约束限制

当Status大于300时为空。

表4 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表5 ListObjectsOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Location

string

参数解释

桶所在的区域。

Bucket

string

参数解释

桶名。

Prefix

string

参数解释:

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

例如,假设您拥有以下对象:logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀,将返回以字符串“logs/”开头的三个对象。如果您指定空的前缀且请求中没有其他过滤条件,将返回桶中的所有对象。

Marker

string

参数解释:

列举对象的起始位置,与请求中的该参数对应。列举桶内对象列表时,指定一个标识符,从该标识符以后按对象名的字典顺序返回对象列表。

Delimiter

string

参数解释:

对象名按照此标识符进行分组。通常与prefix参数搭配使用,如果指定了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。

对于并行文件系统,不携带此参数时默认列举是递归列举此目录下所有内容,会列举子目录。在大数据场景下(目录层级深、目录下文件多)的列举,建议设置[delimiter=/],只列举当前目录下的内容,不列举子目录,提高列举效率。

MaxKeys

number

参数解释:

列举对象的最大数目,与请求中的该参数对应。返回的对象列表将是按照字典顺序的最多前MaxKeys个对象。

IsTruncated

string

参数解释:

表明本次请求是否返回了全部结果。因为每次列举返回对象的数量上限是1000个,如果对象个数大于1000,则无法通过一次请求返回全部结果。

取值范围:

  • true:表示没有返回全部结果。
  • false:表示已返回了全部结果。

NextMarker

string

参数解释:

下次列举对象请求的起始位置。如果本次没有返回全部结果,响应请求中将包含此字段,用于标明本次请求列举到的最后一个对象。后续请求可以指定Marker参数等于该值来列举剩余的对象。

Contents

Content[]

参数解释:

桶内对象列表,详见Content

CommonPrefixes

CommonPrefix[]

参数解释:

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

取值范围:

详见CommonPrefix

EncodingType

string

参数解释:

对响应中的部分元素进行指定类型的编码。如果Delimiter、Marker、Prefix、CommonPrefixes、NextMarker和Key包含xml 1.0标准不支持的控制字符(特殊字符),需设置该参数为url编码。

表6 Content

参数名称

参数类型

描述

Key

string

参数解释:

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

LastModified

string

参数解释:

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

ETag

string

参数解释:

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,都有唯一的ETag。

约束限制:

当对象是服务端加密的对象时,ETag值不是对象的MD5值。

Size

number

参数解释:

对象的字节数。

Owner

Owner

参数解释:

对象的所有者,包含对象拥有者DomainId和对象拥有者名称,详见Owner

StorageClass

string

参数解释:

对象的存储类型。

Type

string

参数解释:

对象的类型。

取值范围:

  • NORMAL:普通对象
  • APPENDABLE:追加写对象
表7 CommonPrefix

参数名称

参数类型

描述

Prefix

string

参数解释:

为桶内对象的前缀。

取值范围:

长度大于0且不超过1024的字符串。

默认取值:

表8 Owner

参数名称

参数类型

是否必选

描述

ID

string

作为请求参数时必选

参数解释:

所有者的账号ID,即domain_id。

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?

默认取值:

DisplayName

string

可选

参数解释:

所有者的账号用户名。

默认取值:

support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0605.html