list-objects命令用于列举存储空间(Bucket)中所有文件(Object)的信息。
注意事项
阿里云账号默认拥有列举Bucket中的所有文件的信息。如果您需要通过RAM用户或者STS的方式进行查看,您必须拥有
oss:ListObjects
权限。具体操作,请参见为RAM用户授权自定义的权限策略。list-objects(get-bucket)已修订为list-objects-v2(get-bucket-v2)。建议您在开发应用程序时使用较新的版本list-objects-v2(get-bucket-v2)。为保证向后兼容性,OSS继续支持list-objects(get-bucket)。
执行list-objects(get-bucket)请求时不会返回Object中自定义的元信息。
命令格式
ossutil api list-objects --bucket value [flags]
参数 | 类型 | 说明 |
--bucket | string | Bucket的名称。 |
--delimiter | string | 对Object名字进行分组的字符。 |
--encoding-type | string | 对返回的内容进行编码并指定编码的类型。 |
--marker | string | 设定从marker之后按字母排序开始返回Object。 |
--max-keys | int | 指定返回Object的最大数。 |
--prefix | string | 限定返回文件的Key必须以Prefix作为前缀。 |
list-objects命令对应API接口GetBucket(ListObjects)。关于API中的具体参数含义,请参见GetBucket (ListObjects)。
关于支持的全局命令行选项,请参见支持的全局命令行选项。
使用示例
以下示例展示了如何列举存储空间examplebucket
中所有Object
的信息。
ossutil api list-objects --bucket examplebucket
以下示例展示了如何列举存储空间examplebucket
中所有Object
的信息,以JSON格式显示。
ossutil api list-objects --bucket examplebucket --output-format json
以下示例展示了如何列举存储空间examplebucket
中所有Object
的信息,以YAML格式显示。
ossutil api list-objects --bucket examplebucket --output-format yaml
以下示例展示了如何列举存储空间examplebucket
中指定前缀dir
下的所有Object
的信息。
ossutil api list-objects --bucket examplebucket --prefix dir
以下示例展示了如何列举存储空间examplebucket
中指定前缀dir
下,前100个Object
的信息。
ossutil api list-objects --bucket examplebucket --prefix dir --max-keys 100
以下示例展示了如何列举存储空间examplebucket
中当前目录下的Object
的信息。
ossutil api list-objects --bucket examplebucket --delimiter/
以下示例展示了如何列举存储空间examplebucket
中指从test.txt
之后的Object
的信息。
ossutil api list-objects --bucket examplebucket --marker test.txt
以下示例展示了如何列举存储空间examplebucket
中所有Object
的信息,并对Object
的名字进行URL编码。
ossutil api list-objects --bucket examplebucket --encoding-type url