对象存储服务 OBS-列举对象:参数说明

时间:2024-05-17 17:39:24

参数说明

参数

约束

描述

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。

format

附加参数,可选

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

config

附加参数,可选

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

e

附加参数,可选

指定终端节点。

i

附加参数,可选

指定用户的AK。

k

附加参数,可选

指定用户的SK。

t

附加参数,可选

指定用户的securitytoken。

support.huaweicloud.com/utiltg-obs/obs_11_0014.html