本文介绍如何使用C# SDK V2在开启版本控制的存储空间(Bucket)中上传文件(Object)。
注意事项
本文示例代码以华东1(杭州)的地域IDcn-hangzhou
为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名。
权限说明
阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。
API | Action | 说明 |
PutObject |
| 上传Object。 |
| 上传Object时,如果通过x-oss-tagging指定Object的标签,则需要此操作的权限。 | |
| 上传Object时,如果Object的元数据包含X-Oss-Server-Side-Encryption: KMS,则需要这两个操作的权限。 | |
|
示例代码
简单上传
在已开启版本控制的Bucket中,OSS会为新添加的Object自动生成唯一的VersionId,并在响应header中通过x-oss-version-id形式返回。
在暂停了版本控制的Bucket中,新添加的Object的VersionId为“null”,上传同名Object,后一次会覆盖前一次上传的文件内容。OSS保证同一个Object只会有一个版本的ID为“null”。
您可以使用以下代码进行简单上传。
using System.Text; // 引入System.Text命名空间,用于处理字符编码(如UTF-8编码字符串)
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 key"; // 必须项,指定上传的对象名称。格式(folder/objectName)
// 加载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);
// 待上传的对象内容。示例内容:简单字符串"hello oss!",实际场景中可为文件流、字节数组等
var content = "hello oss!";
// 将字符串转换为UTF-8编码的字节数组,再包装为MemoryStream
// MemoryStream用于在内存中处理数据流,适合小文件上传;大文件建议使用FileStream
var bodyStream = new MemoryStream(Encoding.UTF8.GetBytes(content));
// 调用PutObjectAsync方法异步上传对象(需传入包含Bucket、Key和Body的请求对象)
// 该方法会将bodyStream中的数据上传至指定Bucket的Key路径下
var result = await client.PutObjectAsync(new OSS.Models.PutObjectRequest()
{
Bucket = bucket, // 目标Bucket名称
Key = key, // 对象在Bucket中的唯一Key
Body = bodyStream // 要上传的内容流(此处为内存中的字符串数据)
});
// 打印上传结果
Console.WriteLine("PutObject 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)); // 遍历并打印所有响应头
追加上传
在受版本控制的Bucket中,仅支持对于当前版本为Appendable类型的Object执行追加(AppendObject)操作,不支持对于历史版本为Appendable类型的Object执行AppendObject操作。
对当前版本为Appendable类型的Object执行AppendObject操作时,OSS不会为该Appendable类型的Object生成历史版本。
对当前版本为Appendable类型的Object执行PutObject或DeleteObject操作时,OSS会将该Appendable类型的Object保留为历史版本,且该Object不允许继续追加。
不支持对当前版本为非Appendable类型的Object(包括 Normal Object、Delete Marker等)执行AppendObject 操作。
您可以使用以下代码进行追加上传。
using System.Text; // 引入System.Text命名空间,用于处理字符编码(如UTF-8编码字符串)
using OSS = AlibabaCloud.OSS.V2; // 为阿里云OSS SDK创建别名,简化后续使用
var region = "cn-hangzhou"; // 必须项,设置Bucket所在的区域(Region)。以华东1(杭州)为例,Region填写为cn-hangzhou
var bucket = "you bucket name"; // 必须项,设置目标Bucket名称
var endpoint = null as string; // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
var key = "your object key"; // 必须项,需追加的对象名称。格式(folder/objectName)
// 加载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);
// 定义要追加到OSS对象的第一部分内容
var content1 = "hello,";
// 定义要追加到OSS对象的第二部分内容
var content2 = "oss!";
// 调用AppendObjectAsync方法,执行第一次追加操作
var result1 = await client.AppendObjectAsync(new OSS.Models.AppendObjectRequest()
{
// 指定目标Bucket
Bucket = bucket,
// 指定目标Object名称
Key = key,
// 首次追加时,起始位置必须为0
Position = 0,
Body = new MemoryStream(Encoding.UTF8.GetBytes(content1))
});
// 调用AppendObjectAsync方法,执行第二次追加操作,接续在上一次结束的位置
var result2 = await client.AppendObjectAsync(new OSS.Models.AppendObjectRequest()
{
// 目标Bucket保持不变
Bucket = bucket,
// 目标Object名称保持不变
Key = key,
// 从上一次追加结束的位置继续写入
Position = result1.NextAppendPosition,
Body = new MemoryStream(Encoding.UTF8.GetBytes(content2))
});
// 打印上传结果
Console.WriteLine("AppendObject done"); // 提示操作完成
Console.WriteLine($"StatusCode: {result2.StatusCode}"); // HTTP状态码
Console.WriteLine($"RequestId: {result2.RequestId}"); // RequestId,用于阿里云排查问题
Console.WriteLine("Response Headers:"); // 响应头信息
result2.Headers.ToList().ForEach(x => Console.WriteLine(x.Key + " : " + x.Value)); // 遍历并打印所有响应头
Console.WriteLine($"NextAppendPosition: {result2.NextAppendPosition}"); // 输出下一次追加的起始位置