QingStor 对象存储到目前为止已经发布了包括 Go、Ruby、Swift、Java、JavaScript、PHP、Python、Scala 等八种语言的 SDK,为了方便 .NET 平台的用户使用 QingStor 对象存储服务,现特新增 .NET SDK。
QingStor .NET SDK 通过开源的 QingStor 对象存储的 API Specifications(OpenAPI 格式,亦称 Swagger 2.0 格式)及 SDK 生成工具 Snips 来生成相应的SDK接口和公共基础部分,在 Snips 的帮助下使其能够在短时间内开发出符合生产环境使用的SDK。
下文为简要使用文档,更多详细信息请参见 https://github.com/yunify/qingstor-sdk-net。
1. 安装
可通过以下三种安装方式任意一种安装。
- 直接下载源码并将其添加至项目:
$ git clone https://github.com/yunify/qingstor-sdk-net.git
- 直接添加 DLL 引用:
在 GitHub 的 Release 页面 下载相应版本的 DLL,然后将其添加至项目引用。由于此 SDK 依赖于 Json.NET,可以添加该 SDK 对应版本的 Newtonsoft.Json.dll 引用或者使用 NuGet来安装它: Install-Package Newtonsoft.Json
- 通过包管理器(NuGet)安装:
例如在 Visual Studio 2013 中,打开 NuGet 程序包管理器搜索 QingStor_SDK_NET 或者在控制台中键入以下命令(其中,QingStor_SDK_NET45 表示 .NET Framework 4.5 平台下的SDK): Install-Package QingStor_SDK_NET45
2. 初始化服务
发起请求前首先建立初始化服务:
using QingStor_SDK_NET.Common; using QingStor_SDK_NET.Service; CConfig Config = new CConfig("Config.yaml"); CQingStor Service = new CQingStor(Config);
上面代码初始化了一个 QingStor Service。
3. 获取账户下的 Bucket 列表
CListBucketsOutput ListBuckets = Service.ListBuckets(null); // Print the HTTP status code. // Example: 200 Console.Write(ListBuckets.StatusCode); // Print the bucket count. // Example: 5 Console.Write(ListBuckets.count);
4. 创建 Bucket
初始化并创建 Bucket, 需要指定 Bucket 名称和所在 Zone
CBucket Bucket = Service.Bucket("bucket-name", "pek3a");
CPutBucketOutput PutBucketOutput = Bucket.Put();
5. 获取 Bucket 中存储的 Object 列表
CListObjectsOutput ListObjectsOutput = Bucket.ListObjects(null); // Print the HTTP status code. // Example: 200 Console.Write(ListObjectsOutput.StatusCode); // Print the key count. // Example: 0 Console.Write(ListObjectsOutput.keys.Length);
6. 创建一个 Object
CPutObjectInput PutObjectInput = new CPutObjectInput(); PutObjInput.Body = new FileStream("/tmp/Screenshot.jpg", FileMode.Open); CPutObjectOutput PutObjectOutput = Bucket.PutObject("Screenshot.jpg", PutObjectInput); // Print the HTTP status code. // Example: 201 Console.Write(PutObjectOutput.StatusCode);
7. 删除一个 Object
CDeleteObjectOutput DeleteObjectOutput = BucketObj.DeleteObject("Screenshot.jpg"); // Print the HTTP status code. // Example: 204 Console.Write(DeleteObjectOutput.StatusCode);
8. 设置 Bucket ACL
CGranteeType Grantee = new CGranteeType() { id = "usr-id", type = "user" }; CACLType ACL = new CACLType() { grantee = Grantee, permission = "FULL_CONTROL" }; CPutBucketACLInput PutBucketACLInput = new CPutBucketACLInput(); PutBucketACLInput.acl = new CACLType[] { ACL }; CPutBucketACLOutput PutBucketACLOutput = Bucket.PutACL(PutBucketACLInput); // Print the HTTP status code. // Example: 200 Console.Write(PutBucketACLOutput.StatusCode);