追加上傳是指在已上傳的追加類型檔案(Appendable Object)末尾直接追加內容。本文介紹如何使用OSS C# SDK進行追加上傳。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。當檔案不存在時,調用追加上傳方法會建立一個追加類型檔案。
當檔案已存在時:
如果檔案為追加類型檔案,且設定的追加位置和檔案當前長度相等,則直接在該檔案末尾追加內容。
如果檔案為追加類型檔案,但是設定的追加位置和檔案當前長度不相等,則拋出PositionNotEqualToLength異常。
如果檔案為非追加類型檔案,例如通過簡單上傳的檔案類型為Normal的檔案,則拋出ObjectNotAppendable異常。
許可權說明
阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權,需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。
API | Action | 說明 |
AppendObject |
| 以追加寫的方式上傳檔案(Object)。 |
| 以追加寫的方式上傳檔案(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。