追加上传(C# SDK V2)

追加上传是指在已上传的追加类型文件(Appendable Object)末尾直接追加内容。本文介绍如何使用OSS C# SDK进行追加上传。

注意事项

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

  • 当文件不存在时,调用追加上传方法会创建一个追加类型文件。

  • 当文件已存在时:

    • 如果文件为追加类型文件,且设置的追加位置和文件当前长度相等,则直接在该文件末尾追加内容。

    • 如果文件为追加类型文件,但是设置的追加位置和文件当前长度不相等,则抛出PositionNotEqualToLength异常。

    • 如果文件为非追加类型文件,例如通过简单上传的文件类型为Normal的文件,则抛出ObjectNotAppendable异常。

权限说明

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

API

Action

说明

AppendObject

oss:PutObject

以追加写的方式上传文件(Object)。

oss:PutObjectTagging

以追加写的方式上传文件(Object)时,如果通过x-oss-tagging指定Object的标签,则需要此操作的权限。

示例代码

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}"); // 输出下一次追加的起始位置

相关文档

关于追加上传的完整示例代码,请参见AppendObject.cs