本文介紹如何使用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}"); // 輸出下一次追加的起始位置