删除文件(C# SDK V2)

本文介绍如何使用OSS C# SDK删除指定的单个文件和删除指定的多个文件。

注意事项

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

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

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

示例代码

删除单个对象

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";  // 必须项,目标文件对象名称


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

// 调用DeleteObjectAsync方法删除目标对象
var result = await client.DeleteObjectAsync(new OSS.Models.DeleteObjectRequest()
{
    Bucket = bucket,
    Key = key,
});

// 打印结果信息
Console.WriteLine("DeleteObject 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));  // 遍历并打印所有响应头

删除多个对象

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 keys = new List<String>  // 必须项,需删除的目标对象
{
    "your object key1",
    "your object key2",
    "your object key3"
};

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

// 创建待删除对象的集合
var objects = new List<OSS.Models.DeleteObject>();
// 遍历要删除的对象键列表(若keys为null则跳过)
foreach (var item in keys ?? [])
{
    objects.Add(new OSS.Models.DeleteObject()
    {
        Key = item,
    });
}

// 调用DeleteMultipleObjectsAsync方法,执行批量删除请求
var result = await client.DeleteMultipleObjectsAsync(new OSS.Models.DeleteMultipleObjectsRequest()
{
    Bucket = bucket,
    Objects = objects
});

// 打印结果信息
Console.WriteLine("DeleteMultipleObjects 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));  // 遍历并打印所有响应头
Console.WriteLine("Key to be deleted:");  
keys?.ToList().ForEach(x => Console.WriteLine(x));  // 打印已删除的对象列表

相关文档

关于删除文件的完整示例代码,请参见delete_object.cs