如何通过C# SDK V2下载Bucket中的文件_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用C# SDK V2在开启版本控制的存储空间（Bucket）中下载文件（Object）。

注意事项

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

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限，需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。

API	Action	说明
GetObject	`oss:GetObject`	下载Object。
	`oss:GetObjectVersion`	下载Object时，如果通过versionId指定了Object的版本，则需要授予此操作的权限。
	`kms:Decrypt`	下载Object时，如果Object的元数据包含X-Oss-Server-Side-Encryption: KMS，则需要此操作的权限。

说明

对某个Bucket执行GetObject操作时，分以下三种情况：

如果该Bucket中Object的当前版本是删除标记（Delete Marker），则返回404 Not Found。
如果在查询参数中指定Object的versionId，则返回指定的Object版本。当versionId指定为“null”时，则返回versionId为“null”的Object版本。
通过指定versionId的方式来获取删除标记时，则返回405 Method Not Allowed。

示例代码

您可以使用以下代码下载文件。

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

var region = "cn-hangzhou";  // 必须项，设置Bucket所在的区域（Region）。以华东1（杭州）为例，Region填写为cn-hangzhou
var bucket = "your bucket name";  // 必须项，设置目标Bucket名称 
var endpoint = null as string;  // 可选项，指定访问OSS服务的域名。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var key = "your object name";  // 必须项，指定下载的对象名称。格式（folder/objectName）
var filePath = "your file path";  // 必须项，指定下载到本地磁盘的文件路径
var versionId = "your object versionId";  // 必须项，指定下载对象的x-oss-version-id


// 加载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); 

// 调用GetObjectToFileAsync方法，直接将OSS对象流式下载到本地磁盘中，避免大文件占用过多内存
var result = await client.GetObjectToFileAsync(new OSS.Models.GetObjectRequest()
{
    Bucket = bucket,
    Key = key,
    VersionId = versionId,
}, filePath);

// 打印上传结果
Console.WriteLine("GetObjectToFile done");  // 提示操作完成
Console.WriteLine($"StatusCode: {result.StatusCode}");  // HTTP状态码
Console.WriteLine($"RequestId: {result.RequestId}");  // RequestId，用于阿里云排查问题
Console.WriteLine("Response Headers:");  // 响应头信息
result.Headers.ToList().ForEach(x => Console.WriteLine(x.Key + " : " + x.Value));  // 遍历并打印所有响应头