.NET快速入門 - Object Storage Service

本文為您提供使用OSS .NET SDK 進行常見儲存操作的快速入門。您將學習如何安裝SDK、配置訪問憑證，以及執行基本操作，包括建立儲存空間（Bucket）、上傳、下載、列舉和刪除檔案（Object）等。

注意事項

關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

配置憑證

請確認您已註冊阿里雲帳號，並完成實名認證。

建立有OSS系統管理權限的RAM使用者AccessKey。
使用ROS指令碼快速建立有OSS系統管理權限的RAM使用者AccessKey
在Resource Orchestration Service控制台的建立資源棧頁面的安全確認下，勾選確認，然後單擊建立。
建立完成後，在輸出中，複製建立的AccessKey。

使用RAM使用者AccessKey配置環境變數。

Linux

在命令列介面執行以下命令來將環境變數設定追加到~/.bashrc 檔案中。

echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

執行以下命令使變更生效。
```
source ~/.bashrc
```

執行以下命令檢查環境變數是否生效。

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET

macOS

在終端中執行以下命令，查看預設Shell類型。

echo $SHELL

根據預設Shell類型進行操作。

Zsh

執行以下命令來將環境變數設定追加到 ~/.zshrc 檔案中。

echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc

執行以下命令使變更生效。
```
source ~/.zshrc
```

執行以下命令檢查環境變數是否生效。

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET

Bash

執行以下命令來將環境變數設定追加到 ~/.bash_profile 檔案中。

echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile

執行以下命令使變更生效。
```
source ~/.bash_profile
```

執行以下命令檢查環境變數是否生效。

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET

Windows

CMD

在CMD中運行以下命令。

setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

運行以下命令，檢查環境變數是否生效。
```
echo %OSS_ACCESS_KEY_ID%
echo %OSS_ACCESS_KEY_SECRET%
```

PowerShell

在PowerShell中運行以下命令。

[Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

運行以下命令，檢查環境變數是否生效。

[Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

參考上述方式修改系統內容變數後，請重啟或重新整理您的編譯運行環境，包括IDE、命令列介面、其他傳統型應用程式及後台服務，以確保最新的系統內容變數成功載入。

安裝SDK

Windows 環境安裝

NuGet 方式安裝

如果您的Visual Studio沒有安裝NuGet，請先安裝NuGet。
在Visual Studio中建立或者開啟已有的專案，選擇工具 > NuGet封裝管理員 > 管理解決方案的NuGet程式包。
搜尋aliyun.oss.sdk，在結果中找到Aliyun.OSS.SDK（適用於.NET Framework）或Aliyun.OSS.SDK.NetCore（適用於.Net Core），選擇最新版本，單擊安裝。

DLL 引用方式安裝

下載並解壓.NET SDK開發包。
在Release模式下編譯aliyun-oss-sdk專案，產生DLL庫。
開啟Visual Studio的方案總管，選擇您的專案，右擊專案名稱，選擇引用 > 添加引用 ，在彈出的對話方塊中選擇瀏覽。
找到DLL庫產生的bin目錄，選擇Aliyun.OSS.dll檔案，單擊確定。

專案引入方式安裝

如果是下載了SDK包或者從GitHub上下載了源碼，並通過源碼安裝，操作步驟如下：

在Visual Studio中，右擊選擇解決方案，在彈出的菜單中單擊添加現有專案。
在彈出的對話方塊中選擇aliyun-oss-sdk.csproj檔案，單擊開啟。
右擊專案名稱，選擇引用 > 添加引用，在彈出的對話方塊中選擇專案選項卡，選中aliyun-oss-sdk專案，單擊確定。

Unix/Mac 環境安裝

通過NuGet方式安裝的步驟如下：

在Xamarin中建立或者開啟已有的專案，選擇工具Add NuGet Packages。
搜尋到Aliyun.OSS.SDK或Aliyun.OSS.SDK.NetCore，選擇最新版本，單擊Add Package添加到專案應用中。

快速使用

以下樣本程式示範了如何建立儲存空間（Bucket）、上傳、下載、列舉和刪除檔案（Object）等。

建立儲存空間

using Aliyun.OSS;
// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// yourBucketName填寫Bucket名稱。
var bucketName = "yourBucketName";

// 建立OSSClient執行個體。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{
    // 建立儲存空間。
    var bucket = client.CreateBucket(bucketName);
    Console.WriteLine("Create bucket succeeded, {0} ", bucket.Name);
}
catch (Exception ex)
{
    Console.WriteLine("Create bucket failed, {0}", ex.Message);
}

上傳檔案

using Aliyun.OSS;

// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填寫Bucket名稱，例如examplebucket。
var bucketName = "examplebucket";
// 填寫Object完整路徑，完整路徑中不能包含Bucket名稱，例如exampledir/exampleobject.txt。
var objectName = "exampledir/exampleobject.txt";
// 填寫本地檔案完整路徑，例如D:\\localpath\\examplefile.txt。如果未指定本地路徑，則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
var localFilename = "D:\\localpath\\examplefile.txt";
// 建立OSSClient執行個體。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{
    // 上傳檔案。
    var result = client.PutObject(bucketName, objectName, localFilename);
    Console.WriteLine("Put object succeeded, ETag: {0} ", result.ETag);
}
catch (Exception ex)
{
    Console.WriteLine("Put object failed, {0}", ex.Message);
}

下載檔案

using Aliyun.OSS;
using Aliyun.OSS.Common;

// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填寫Bucket名稱，例如examplebucket。
var bucketName = "examplebucket";
// 填寫Object完整路徑，完整路徑中不能包含Bucket名稱，例如exampledir/exampleobject.txt。
var objectName = "exampledir/exampleobject.txt";
// 下載Object到本地檔案examplefile.txt，並儲存到指定的本地路徑中（D:\\localpath）。如果指定的本地檔案存在會覆蓋，不存在則建立。
// 如果未指定本地路徑，則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
var downloadFilename = "D:\\localpath\\examplefile.txt";
// 建立OSSClient執行個體。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{   
    // 下載檔案。
    var result = client.GetObject(bucketName, objectName);
    using (var requestStream = result.Content)
    {
        using (var fs = File.Open(downloadFilename, FileMode.OpenOrCreate))
        {
            int length = 4 * 1024;
            var buf = new byte[length];
            do
            {
                length = requestStream.Read(buf, 0, length);
                fs.Write(buf, 0, length);
            } while (length != 0);
        }
    }
    Console.WriteLine("Get object succeeded");
}
catch (OssException ex)
{
    Console.WriteLine("Failed with error code: {0}; Error info: {1}. \nRequestID:{2}\tHostID:{3}",
        ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
    Console.WriteLine("Failed with error info: {0}", ex.Message);
}

列舉檔案

using Aliyun.OSS;
using Aliyun.OSS.Common;
// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填寫Bucket名稱，例如examplebucket。
var bucketName = "examplebucket";
// 建立OSSClient執行個體。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{
    var objects = new List<string>();
    ObjectListing result = null;
    string nextMarker = string.Empty;
    do
    {
        var listObjectsRequest = new ListObjectsRequest(bucketName)
        {
            Marker = nextMarker,
        };
        // 列舉檔案。
        result = client.ListObjects(listObjectsRequest);
        foreach (var summary in result.ObjectSummaries)
        {
            Console.WriteLine(summary.Key);
            objects.Add(summary.Key);
        }
        nextMarker = result.NextMarker;
    } while (result.IsTruncated);
    Console.WriteLine("List objects of bucket:{0} succeeded ", bucketName);
}
catch (OssException ex)
{
    Console.WriteLine("Failed with error code: {0}; Error info: {1}. \nRequestID:{2}\tHostID:{3}",
        ex.ErrorCode, ex.Message, ex.RequestId, ex.HostId);
}
catch (Exception ex)
{
    Console.WriteLine("Failed with error info: {0}", ex.Message);
}

刪除檔案

using Aliyun.OSS;
// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填寫Bucket名稱，例如examplebucket。
var bucketName = "examplebucket";
// 填寫Object完整路徑，完整路徑中不能包含Bucket名稱，例如exampledir/exampleobject.txt。
var objectName = "exampledir/exampleobject.txt";
// 建立OSSClient執行個體。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{
    // 刪除檔案。
    client.DeleteObject(bucketName, objectName);
    Console.WriteLine("Delete object succeeded");
}
catch (Exception ex)
{
    Console.WriteLine("Delete object failed, {0}", ex.Message);
}

運行樣本

在您的測試工程目錄下建立main.cs檔案，根據需要將範例程式碼拷貝至main.cs檔案中。
請替換以下命令裡的"yourRegion"、"yourBucketName"、"yourObjectName"為您的實際配置，其中yourRegion填寫bucket所在地區，例如華東1（杭州）填寫為cn-hangzhou。
```
dotnet script main.cs -- <yourRegion> <yourBucketName> <yourObjectName>
```

常見問題

當使用SDK時遇到報錯AccessDenied該如何進行排查？

當您遇到AccessDenied錯誤時通常是因為沒有相應的存取權限。以下是解決此問題的步驟：

確認AccessKey ID和AccessKey Secret：請確保您使用了正確的AccessKey ID和AccessKey Secret。詳情請參見建立AccessKey。
檢查RAM使用者權限：確認RAM使用者是否擁有Bucket或Object相關操作許可權。具體步驟，請參見為RAM使用者授權。
檢查Bucket Policy：如果錯誤資訊中提到“Access denied by bucket policy”，則表明是受到Bucket Policy的策略拒絕了。詳情請參考Bucket Policy。
更多錯誤類型的查詢，請您參閱EC錯誤碼，例如關於存取控制方面的常見報錯，可參見03-ACCESS_CONTROL。

Object Storage Service：.NET快速入門

注意事項

配置憑證

Linux

macOS

Zsh

Bash

Windows

CMD

PowerShell

安裝SDK

Windows 環境安裝

NuGet 方式安裝

DLL 引用方式安裝

專案引入方式安裝

Unix/Mac 環境安裝

快速使用

建立儲存空間

上傳檔案

下載檔案

列舉檔案

刪除檔案

運行樣本

常見問題

當使用SDK時遇到報錯AccessDenied該如何進行排查？

相關文檔