列举文件(C# SDK V2)

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

注意事项

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

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

示例代码

以下代码用于列举指定Bucket中目标Object的版本信息。

using OSS = AlibabaCloud.OSS.V2;  // 为阿里云OSS SDK创建别名,简化后续使用

var region = "cn-hangzhou";  // 必须项,设置Bucket所在的区域(Region)。以华东1(杭州)为例,Region填写为cn-hangzhou
var endpoint = null as string;  // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var bucket = "your bucket name";  // 必须项,Bucket名称 
var key = "your object name Prefix";  // 必须项,Bucket中目标对象前缀

// 加载OSS SDK的默认配置,此配置会自动从环境变量中读取凭证信息(如AccessKey)
var cfg = OSS.Configuration.LoadDefault();
// 显式设置使用环境变量获取凭证,用于身份验证(格式:OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET)
cfg.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
// 设置配置的Bucket区域
cfg.Region = region;   
// 若已指定了endpoint,则覆盖默认的endpoint 
if(endpoint != null) 
{
    cfg.Endpoint = endpoint;
}

// 使用配置信息创建OSS客户端实例
using var client = new OSS.Client(cfg);

 // 创建ListObjectVersions请求并设置Bucket名称
var request = new OSS.Models.ListObjectVersionsRequest
{
    Bucket = bucket,
    Prefix = key, // 只列出以指定前缀开头的对象版本
    MaxKeys = 100 // 每次请求返回的最大数量
    };

// 创建分页器实例
var paginator = client.ListObjectVersionsPaginator(request);

// 使用foreach循环遍历所有页面
foreach (var page in paginator.IterPage())
{
    if (page.Versions != null)
    {
        foreach (var version in page.Versions)
        {
            Console.WriteLine($"对象键: {version.Key}, 版本ID: {version.VersionId}");
        }
    }
}