Alibaba Cloud Object Storage Service (OSS) is a cloud storage service provided by Alibaba Cloud, featuring massive capacity, security, a low cost, and high reliability.
- The OSS C# SDK is built based on OSS REST API.
- OSS C# SDKOnline Documentation.
- Current version: 2.13.0.
- Applicable to
.NET 2.0or above. - Applicable to
Visual Studio 2010or above.
- Applicable to
Mono 3.12or above.
- Applicable to
.net core 2.0or above
- If NuGet hasn't been installed for Visual Studio, install NuGet first.
- After NuGet is installed, access Visual Studio to create a project or open an existing project, and then select
TOOLS>NuGet Package Manager>Manage NuGet Packages for Solution. - Type
aliyun.oss.sdkin the search box and click Search, findAliyun.OSS.SDKorAliyun.OSS.SDK.NetCorein the search results, select the latest version, and click Install. After installation, the SDK is added to the project.
- If Git hasn't been installed, install Git first.
- Clone project via
git clone https://github.com/aliyun/aliyun-oss-csharp-sdk.git. - After the source code is downloaded, install the SDK by entering
Install via Project Introduction.
- Download the SDK packagefrom the Alibaba Cloud OSS official website. Unzip the package and you will find the Aliyun.OSS.dll file in the bin directory.
- In the Visual Studio, access
Solution Explorer, select your project, right click Project Name, selectAdd Referencefrom the pop-up menu. In theReference Managerdialog box, click Browse, find the directory that the SDK is unzipped to, select the Aliyun.OSS.dll file in the bin directory, and click OK.
- If you have downloaded the SDK package or the source code from GitHub and you want to install the SDK package using the source code, you can right click
Solution Explorerand selectAdd>Existing Projectsfrom the pop-up menu. - In the pop-up dialog box, select the
aliyun-oss-sdk.csprojfile, and click Open. - Right click Your Projects and select
Add Reference. In theReference Managerdialog box, click theProjectstab, select the aliyun-oss-sdk project, and click OK.
- In
Xamarin, create a project or open an existing project, and selectTools>Add NuGet Packages. - Type
aliyun.oss.sdkin the search box and click Search, find 'Aliyun.OSS.SDK' in the search results, select the latest version, and clickAdd Package. After installation, the SDK is added to the project.
- If Git hasn't been installed, install Git first.
- Clone project via
git clone https://github.com/aliyun/aliyun-oss-csharp-sdk.git. - After the source code is downloaded, open it in Xamarin. Compile the aliyun-oss-sdk project in Release mode to generate the
Aliyun.OSS.dllfile. Then install the SDK through DLL reference.
- Download the SDK package from Alibaba Cloud OSS official website. Unzip the package and you will find the Aliyun.OSS.dll file in the bin directory.
- In the Xamarin, access
Solution, select your project, right click Project Name, selectReference' >Edit Referencesfrom the pop-up menu. In theEdit Referencesdialog box, click.Net Assembly>Browse. Find the directory that the SDK is unzipped to, select theAliyun.OSS.dllfile in the bin directory, and click Open.
Starting with version 2.9, OSS SDK supports the .net core 2.0 platform.
To build apps for .Net core 2.0, you need to install the .Net core 2.0 SDK. Windows:https://www.microsoft.com/net/download/windows/build
MacOS: https://www.microsoft.com/net/download/macos
Linux: https://www.microsoft.com/net/download/linux/build
If you just want to run apps of .Net core 2.0, then you need to install the runtime: Windows:https://www.microsoft.com/net/download/windows/run
MacOS: https://www.microsoft.com/net/download/macos/run
Linux: https://www.microsoft.com/net/download/linux/run
- cd to the root folder of OSS SDK.
- dotnet restore aliyun-oss-sdk-dotnetcore.sln
- dotnet build aliyun-oss-sdk-dotnetcore.sln
- Update the samples\Config.cs to update the config properties with your actual OSS AKs and endpoint.
- use the step above to build the whole solution
- cd to the folder where Aliyun.OSS.Samples.dll exists and then run:
dotnet Aliyun.OSS.Samples.dll
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var buckets = client.ListBuckets();
foreach (var bucket in buckets)
{
Console.WriteLine(bucket.Name + ", " + bucket.Location + ", " + bucket.Owner);
} OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.CreateBucket(bucketName); OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.DeleteBucket(bucketName); OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.PutObject(bucketName, key, filePathToUpload); OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var object = ossClient.GetObject(bucketName, key); OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var listResult = client.ListObjects(bucketName);
foreach (var summary in listResult.ObjectSummaries)
{
Console.WriteLine(summary.Key);
} OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.DeleteObject(bucketName, key)- In the example above, if no exception was thrown, it indicates the execution was successful. Otherwise, it indicates the execution failed. More detailed examples can be found and run in the aliyun-oss-sample project.
- If you want to run a sample project, you must set the aliyun-oss-sdk-sample project as the 'Startup Project' and add your own AccessKeyId, AccessKeySecret, buckets and keys, and then run the project.
- Alibaba Cloud OSS official website.
- Alibaba Cloud OSS official forum.
- Alibaba Cloud OSS official documentation center.
- Alibaba Cloud official technical support: Submit a ticket.