列举文件

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

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要列举文件,您必须有oss:ListObjectVersions权限。具体操作,请参见RAM用户授予自定义的权限策略

示例代码

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

import AlibabaCloudOSS
import Foundation
@main
struct Main {
    static func main() async {
        do {
            // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为cn-hangzhou。
            let region = "cn-hangzhou"
            // 填写Bucket名称。
            let bucket = "yourBucketName"
            // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil
            
            // 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
            let credentialsProvider = EnvironmentCredentialsProvider()
            // 配置OSS客户端参数
            let config = Configuration.default()
                .withRegion(region)        // 设置Bucket所在地域
                .withCredentialsProvider(credentialsProvider)  // 设置访问凭证
                
            // 设置Endpoint
            if let endpoint = endpoint {
                config.withEndpoint(endpoint)
            }
            
            // 创建OSS客户端实例
            let client = Client(config)
            // 列举指定Bucket中所有Object的版本信息
            var isTruncated = false
            var keyMarker: String?
            var versionIdMarker: String?
            repeat {
                let result = try await client.listObjectVersions(
                    ListObjectVersionsRequest(
                        bucket: bucket,
                        keyMarker: keyMarker,
                        versionIdMarker: versionIdMarker
                    )
                )
                for version in result.versions ?? [] {
                    print("key: \(version.key ?? ""), version id: \(version.versionId ?? "")")
                }    
                isTruncated = result.isTruncated ?? false
                keyMarker = result.nextKeyMarker
                versionIdMarker = result.nextVersionIdMarker
            } while isTruncated
        } catch {
            // 错误输出
            print("error:\(error)")
        }
    }
}

相关文档

  • 关于列举对象版本的完整示例代码,请参见GitHub示例