文档首页/ 对象存储服务 OBS/ 工具指南/ obsutil/ 对象相关命令/ 列举对象
更新时间：2024-09-03 GMT+08:00
查看PDF
分享

列举对象

功能说明

查询桶内对象或多版本对象，返回对象列表将按照对象名和版本号以字典序排列。

命令结构

  • Windows操作系统 
    obsutil ls obs://bucket[/prefix] [-s] [-d][-fs] [-v] [-du] [-marker=xxx] [-versionIdMarker=xxx] [-encoding-type=url][-bf=xxx] [-limit=1] [-format=default] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
  • macOS/Linux操作系统 
    ./obsutil ls obs://bucket[/prefix] [-s][-fs] [-d] [-v] [-du] [-marker=xxx] [-versionIdMarker=xxx] [-encoding-type=url][-bf=xxx] [-limit=1] [-format=default] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

运行示例

  • 示例1：以Windows操作系统为例，运行obsutil ls obs://bucket-test -limit=10，查询桶内对象。 
    obsutil ls obs://bucket-test -limit=10

Folder list:
obs://bucket-test/api/

Object list:
key                                               LastModified                  Size      StorageClass        ETag                
obs://bucket-test/AUTHORS                         2018-11-16T02:15:49Z          33243     standard            "796393c1eaf502ef56a85c2ceb640aea"

obs://bucket-test/CONTRIBUTING.md                 2018-11-16T02:15:49Z          1366      standard            "12d93325ba6131f852daecd18dd65edc"

obs://bucket-test/CONTRIBUTORS                    2018-11-16T02:15:49Z          45710     standard            "b486b5003e6215c9199e86ab3ccec9fa"

obs://bucket-test/LICENSE                         2018-11-16T02:15:49Z          1479      standard            "5d4950ecb7b26d2c5e4e7b4e0dd74707"

obs://bucket-test/PATENTS                         2018-11-16T02:15:49Z          1303      standard            "3a55d95595a6f9e37dee53826b4daff2"

obs://bucket-test/README.md                       2018-11-16T02:15:49Z          1399      standard            "97351fd7946b9ea021a31a86ba2a10ab"

obs://bucket-test/VERSION                         2018-11-16T02:15:49Z          7         standard            "43d93b553855b0e1fc67e31c28c07b65"

obs://bucket-test/api/README                      2018-11-16T02:15:49Z          521       standard            "4e9e63a87075df60cdf65c8ce9e92117"

obs://bucket-test/api/except.txt                  2018-11-16T02:15:49Z          20194     standard            "8eb96de3f60447e2f09a7531c99fb3ee"

Next marker is: api/except.txt
Folder number is: 1
File number is: 9
  • 示例2：以Windows操作系统为例，运行obsutil ls obs://bucket-test2，查询桶内对象。 
    obsutil ls obs://bucket-test2

Object list:
key                                               LastModified                  Size      StorageClass        ETag    
obs://bucket-test2/123                            2022-03-29T09:17:51Z          0B        standard            "d41d8cd98f00b204e9800998ecf8427e"

obs://bucket-test2/1_2-3.txt                      2022-03-29T09:17:51Z          0B        standard            "d41d8cd98f00b204e9800998ecf8427e"

obs://bucket-test2/1_2-3_33.txt                   2022-03-29T09:17:51Z          200B      standard            "dcf204c11d791255adc63e61763c2426"

obs://bucket-test2/新建文本文档.txt
                                                  2022-03-29T09:17:51Z          0B        standard            "d41d8cd98f00b204e9800998ecf8427e"

Total size of bucket is: 200B
Folder number is: 0
File number is: 4
  • 示例3：以Windows操作系统为例，运行obsutil ls obs://bucket-test2/prefix，查询桶内以prefix为前缀的对象。 
    obsutil ls obs://bucket-test2/prefix

Object list:
key                                               LastModified                  Size      StorageClass        ETag    
obs://bucket-test2/prefix                         2022-03-29T09:17:51Z          0B        standard            "d41d8cd98f00b204e9800998ecf8427e"

obs://bucket-test2/prefix2                        2022-03-29T09:17:51Z          0B        standard            "d41d8cd98f00b204e9800998ecf8427e"

Total size of bucket is: 0B
Folder number is: 0
File number is: 2
  • 更多运行示例，请参见列举示例。

参数说明

参数

约束

描述

bucket

必选

桶名。

prefix

可选

列举对象时的对象名前缀。

说明：

如果为空，则表示列举桶内所有对象。

s

附加参数，可选

以精简格式显示查询结果。

说明：

在精简格式下，返回结果只包含对象名。

d

附加参数，可选

仅列举当前目录下的对象和子目录，而非递归列举所有对象和子目录。

对于并行文件系统目录，大数据场景下（目录层级深、目录下文件多）的列举，建议使用此参数限制列举范围。

说明：

OBS中约定以“/”作为目录分隔符。

v

附加参数，可选

列举桶内多版本对象，列举结果包含最新版本的对象和历史版本的对象（如果有）。

marker

附加参数，可选

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

说明：

请参考列举示例理解该参数的使用方式。

versionIdMarker

附加参数，可选，必须与v和marker配合使用

列举桶内多版本对象的起始位置，返回结果是对象名和版本号按照字典序排序后该参数以后的所有对象。

说明：

如果versionIdMarker不是marker的一个版本号，则该参数无效。

bf

附加参数，可选

列举结果中字节数的显示格式。支持的值：

  • human-readable
  • raw
说明：

如果未设置该参数，则列举结果中字节数的显示格式由配置文件中的humanReadableFormat参数决定。

du

附加参数，可选

快速返回所列举对象的总大小，不显示具体的对象信息，可与其他参数配合使用。

说明：

如果所列举对象过多，需稍候。

注意：
  • Util 5.4.6 版本及以上支持该参数。

fs

附加参数，可选

是否使用并行文件系统的列举方式，如果桶是并行文件系统，推荐加上该参数。

注意：
  • 该列举方式会因为目录结构，耗时会差别很大。
  • 该参数开启后，会忽略marker和limit值，统计桶或者并行文件系统或者指定目录的大小。
  • Util 5.5.12版本及以上支持该参数。

limit

附加参数，可选

列举结果的最大个数，小于等于0表示列举所有结果，不设置时的默认值为1000。

说明：

如果桶内对象较多，建议设置该值限制每次列举的对象个数，列举结束后，如果仍有对象，会在结果中返回下次请求的marker和versionIdMarker，用于继续列举剩余的对象。

encoding-type

附加参数，可选

对象名有特殊字符时，取值为url。

说明：

Util 5.5.12版本及以上支持该参数。

format

附加参数，可选

指定以自定义格式打印列举结果。当前仅支持值[default]，指定列举结果在一行显示。

config

附加参数，可选

运行当前命令时的自定义配置文件，可支持的配置参数请参考配置参数说明。

e

附加参数，可选

指定终端节点。

i

附加参数，可选

指定用户的AK。

k

附加参数，可选

指定用户的SK。

t

附加参数，可选

指定用户的securitytoken。

响应结果

字段名

描述

Key

对象名。

LastModified

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

Size

对象的大小。

StorageClass

对象的存储类型。

  • standard：标准存储，拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（<1MB），且需要频繁访问数据的业务场景。
  • warm：低频访问存储，适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。
  • cold：归档存储，适用于很少访问（平均一年访问一次）数据的业务场景。

ETag

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