如何通过Python SDK V2列举Bucket的文件_对象存储(OSS)-阿里云帮助中心

本文介绍如何在开启版本控制状态下列举存储空间下（Bucket）的所有文件（Object）、指定个数的文件、指定前缀的文件等。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要列举文件，您必须有oss:ListObjectVersions权限。具体操作，请参见为RAM用户授权自定义的权限策略。

示例代码

以下代码用于列举指定Bucket中包括删除标记（Delete Marker）在内的所有Object的版本信息.

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：示例展示如何列出OSS存储空间中的对象版本
parser = argparse.ArgumentParser(description="list object versions sample")

# 添加命令行参数 --region，表示存储空间所在的区域，必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket，表示要操作的存储空间名称，必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint，表示其他服务可用来访问OSS的域名，非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行提供的参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问OSS所需的认证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 创建用于分页列出对象版本的Paginator对象
    paginator = client.list_object_versions_paginator()

    # 遍历对象版本页面
    for page in paginator.iter_page(oss.ListObjectVersionsRequest(
            bucket=args.bucket,  # 存储空间名
        )
    ):
        # 遍历当前页面中的每个对象版本
        for o in page.version:
            # 打印每个对象版本的关键信息：
            # - key: 对象的键（名称）
            # - size: 对象的大小（字节数）
            # - version_id: 对象版本ID
            # - last_modified: 对象最后修改时间
            print(f'Object version: {o.key}, Size: {o.size}, Version_id: {o.version_id}, Last_modified: {o.last_modified}')


# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

常见使用场景

列举指定目录下所有文件

以下示例代码通过设置Prefix参数，列举指定目录下所有文件的信息，包括文件大小、文件最后修改时间以及文件名等。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：示例展示如何列出OSS存储空间中的对象版本
parser = argparse.ArgumentParser(description="list object versions sample")

# 添加命令行参数 --region，表示存储空间所在的区域，必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket，表示要操作的存储空间名称，必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint，表示其他服务可用来访问OSS的域名，非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行提供的参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问OSS所需的认证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 创建用于分页列出对象版本的Paginator对象
    paginator = client.list_object_versions_paginator()

    # 遍历对象版本页面
    for page in paginator.iter_page(oss.ListObjectVersionsRequest(
            bucket=args.bucket,  # 存储空间名
            prefix="exampledir/",  # 列举出exampledir目录下的所有对象版本
        )
    ):
        # 遍历当前页面中的每个对象版本
        for o in page.version:
            # 打印每个对象版本的关键信息：
            # - key: 对象的键（名称）
            # - size: 对象的大小（字节数）
            # - version_id: 对象版本ID
            # - last_modified: 对象最后修改时间
            print(f'Object version: {o.key}, Size: {o.size}, Version_id: {o.version_id}, Last_modified: {o.last_modified}')


# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

列举指定前缀的文件

以下示例代码通过设置Prefix参数，列举指定前缀的文件信息，包括文件大小、文件最后修改时间以及文件名等。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：示例展示如何列出OSS存储空间中的对象版本
parser = argparse.ArgumentParser(description="list object versions sample")

# 添加命令行参数 --region，表示存储空间所在的区域，必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket，表示要操作的存储空间名称，必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint，表示其他服务可用来访问OSS的域名，非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行提供的参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问OSS所需的认证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 创建用于分页列出对象版本的Paginator对象
    paginator = client.list_object_versions_paginator()

    # 遍历对象版本页面
    for page in paginator.iter_page(oss.ListObjectVersionsRequest(
            bucket=args.bucket,  # 存储空间名
            prefix="test-",  # 列举出以"test-"开头的所有对象版本
        )
    ):
        # 遍历当前页面中的每个对象版本
        for o in page.version:
            # 打印每个对象版本的关键信息：
            # - key: 对象的键（名称）
            # - size: 对象的大小（字节数）
            # - version_id: 对象版本ID
            # - last_modified: 对象最后修改时间
            print(f'Object version: {o.key}, Size: {o.size}, Version_id: {o.version_id}, Last_modified: {o.last_modified}')


# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

列举指定个数的文件

以下示例代码通过设置MaxKeys参数，列举指定个数的文件的信息，包括文件大小、文件最后修改时间以及文件名等。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：示例展示如何列出OSS存储空间中的对象版本
parser = argparse.ArgumentParser(description="list object versions sample")

# 添加命令行参数 --region，表示存储空间所在的区域，必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket，表示要操作的存储空间名称，必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint，表示其他服务可用来访问OSS的域名，非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行提供的参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问OSS所需的认证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 创建用于分页列出对象版本的Paginator对象
    paginator = client.list_object_versions_paginator()

    # 遍历对象版本页面
    for page in paginator.iter_page(oss.ListObjectVersionsRequest(
            bucket=args.bucket,  # 存储空间名
            max_keys=10,          # 每次请求返回的最大对象版本数量
        )
    ):
        # 遍历当前页面中的每个对象版本
        for o in page.version:
            # 打印每个对象版本的关键信息：
            # - key: 对象的键（名称）
            # - size: 对象的大小（字节数）
            # - version_id: 对象版本ID
            # - last_modified: 对象最后修改时间
            print(f'Object version: {o.key}, Size: {o.size}, Version_id: {o.version_id}, Last_modified: {o.last_modified}')

        print('-' * 30)


# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

Python列举文件