S3.Net SDK 文档 1 SDK 说明对象存储.Net SDK 使用开源的 S3.Net SDK 本文档介绍用户如何使用 S3.Net SDK 来使用对象存储服务更加详细的接口参数说明, 请在使用时参照 S3.Net SDK 官方说明

Size: px

Start display at page:

Download "S3.Net SDK 文档 1 SDK 说明对象存储.Net SDK 使用开源的 S3.Net SDK 本文档介绍用户如何使用 S3.Net SDK 来使用对象存储服务更加详细的接口参数说明, 请在使用时参照 S3.Net SDK 官方说明"

凰伊
5 years ago
Views:

1 S3.Net SDK 文档 1 SDK 说明对象存储.Net SDK 使用开源的 S3.Net SDK 本文档介绍用户如何使用 S3.Net SDK 来使用对象存储服务更加详细的接口参数说明, 请在使用时参照 S3.Net SDK 官方说明 2 安装 SDK 2.1 依赖环境 windows 平台 : 安装.Net AWS S3 SDK 首先要确保已经安装.Net Framework 和 Microsoft Visual Studio, 对于版本的要求分别为 : Microsoft.Net Framework 版本号 3.5 Microsoft Visual Studio 2010 linux 平台 : Mono JIT compiler version SDK 安装在安装了上一小节要求的依赖环境后, 就要开始安装 S3.Net SDK 了 windows 平台 : 首先要从 AWS 官网上下载 S3.Net SDK, 然后安装从 AWS 官网下载 S3.Net SDK, 地址为下载格式为 MSI 的安装包 ; 安装下载的 S3.Net SDK 安装包 ; linux 平台 :yum install nuget && nuget install AWSSDK.S3 Version 桶的 Endpoint 对象存储服务的 Endpoint:

2 数据中心 Endpoint beijing 1.cmecloud.cn beijing 2.cmecloud.cn 对应 Location 值 beijing1 beijing2 创建桶的时候指定桶要创建在的区域, 比如要创建的桶要在 beijing1 数据中心的话, 桶的请求的 Endpoint 要写 1.cmecloud.cn,BucketRegionName= beijing1, 创建的桶要在 beijing2 数据中心的话, 桶的请求的 Endpoint 要写 2.cmecloud.cn,BucketRegionName= beijing2, 设置桶的属性如多版本,ACL, 静态网站, 防盗链, 上传数据到桶, 下载桶内对象的时候, 桶在哪个数据中心, 请求的 Endpoint 就写哪个数据中心不管在哪个数据中心, 用户都能获得用户的桶列表和查询桶所在的数据中心 3 桶管理确认您已经理解对象存储基本概念, 如 Bucket Object Endpoint Accesskey 和 SecretKey 等下面介绍如何使用 S3.Net SDK 来访问对象存储服务, 包括列举所有桶创建桶遍历桶对象设置多版本和设置访问控制列表等功能注 : 客户端的创建及参数配置只在列举桶功能中进行展示, 其他功能访问时, 代码类似 3.1 列举所有桶

3 using System; using Amazon.S3; using Amazon.S3.Model; class listbuckets public static void Main(string[] args) Amazon.S3.AmazonS3Config clientconfig = new Amazon.S3.AmazonS3 Config() ServiceURL = " ForcePathStyle = true, SignatureVersion = "2", SignatureMethod = Amazon.Runtime.SigningAlgorithm.HmacSHA1, AmazonS3Client client = new AmazonS3Client(" 你的 access-key"," 你的 secret-key",clientconfig); ListBucketsResponse response = client.listbuckets(); foreach (S3Bucket b in response.buckets) Console.WriteLine("0\t1", b.bucketname, b.creationdat e); 代码中 Access key 和 Secret Key 分别为对应账号的 Access key 和 Secret key; 其中 AWSClientConfig 代表的是对访问信息的配置, 一般要配置提供对象存储服务的 IP 地址和端口号采用的签名算法签名版本 3.2 创建桶桶用于存储用户上传的对象桶的名字必须是唯一的, 如果 bucket 已经被其他用户使用, 则会创建失败桶可以创建在数据中心 beijing1 或者数据中心 beijing2, 如果创建在数据中心 beijing1 则 ServiceURL = beijing 1.cmecloud.cn, 如果创建数据中心为 beijing2, 则 ServiceURL = beijing 2.cmecloud.cn 并且 PutBucketRequest 里 BucketRegionName 设置为 beijing2 且 UseClientRegion =true 的下面为相关的代码示例 : 创建在数据中心 beijing1

4 using System; using Amazon.S3; using Amazon.S3.Model; class createbucketinbeijing1 public static void Main(string[] args) Amazon.S3.AmazonS3Config clientconfig = new Amazon.S3.AmazonS3 Config() ServiceURL = " ForcePathStyle = true, SignatureVersion = "2", SignatureMethod = Amazon.Runtime.SigningAlgorithm.HmacSHA1, AmazonS3Client client = new AmazonS3Client(" 你的 access-key"," 你的 secret-key",clientconfig); PutBucketRequest request = new PutBucketRequest client.putbucket(request); Console.WriteLine("Bucket Created"); 创建在数据中心 beijing2

5 using System; using Amazon.S3; using Amazon.S3.Model; class createbucketinbeijing2 public static void Main(string[] args) Amazon.S3.AmazonS3Config clientconfig = new Amazon.S3.AmazonS3 Config() ServiceURL = " ForcePathStyle = true, SignatureVersion = "2", SignatureMethod = Amazon.Runtime.SigningAlgorithm.HmacSHA1, AmazonS3Client client = new AmazonS3Client(" 你的 access-key"," 你的 secret-key",clientconfig); PutBucketRequest request = new PutBucketRequest UseClientRegion = true, BucketRegionName = "beijing2", client.putbucket(request); Console.WriteLine("Bucket Created"); 查询桶所在数据中心

6 using System; using Amazon.S3; using Amazon.S3.Model; class Upload public static void Main(string[] args) // Create a client Amazon.S3.AmazonS3Config clientconfig = new Amazon.S3.AmazonS3 Config() ServiceURL = " ForcePathStyle = true, SignatureVersion = "2", SignatureMethod = Amazon.Runtime.SigningAlgorithm.HmacSHA1, AmazonS3Client client = new AmazonS3Client(" 你的 access-key"," 你的 secret-key",clientconfig); var request = new GetBucketLocationRequest() BucketName = " 你的桶名字 " var response = client.getbucketlocation(request); Console.WriteLine(response.Location.ToString()); 3.3 列举所有桶对象将用户指定的桶中存储的对象, 按照列表的形式展现出来列举所有桶对象主要有三种方法 : 简单列举按前缀列举简单列举简单列举就是提供桶名后, 然后列举桶中所有的对象以下为示例代码 # 桶在哪个数据中心,ServiceURL 填写哪个数据中心的 Endpoint client.listobjects(" 您的桶名 ");

7 3.3.2 按前缀列举 # 桶在哪个数据中心,ServiceURL 填写哪个数据中心的 Endpoint client.listobjects(" 您的桶名 ", " 对象前缀 ") 3.4 删除桶删除指定的桶只有该桶中所有的对象被删除了, 该桶才能被删除另外, 只有该桶的拥有者才能删除它 # 桶在哪个数据中心,ServiceURL 填写哪个数据中心的 Endpoint client.deletebucket(" 要删除的桶的桶名 "); 3.5 设置多版本设置桶的多版本状态桶的多版本状态有以下两种 : Enabled: 开启多版本 Suspended: 暂停多版本默认情况下, 新建桶处于关闭多版本状态开启桶的多版本, 注意如果要对多版本桶下的非当前版本对象进行操作的话需要带上对象的版本号通过设置桶的多版本特性, 桶中对应的对象可以有同名的对象的不同版本以下为示例代码 PutBucketVersioningRequest myrequest = new PutBucketVersioningReque st () VerConfig.Status = "Enabled"; client.putbucketversioning(myrequest); 程序中 VerConfig 为自定义的 Amazon.S3.Model.S3BucketVersioningConfig 类型的变量, 用来配置多版本的启停 3.6 防盗链管理通过设置桶的防盗链, 可以指定哪些网站可以访问桶内资源

8 string newpolicy ""Version"": "" "", ""Statement"": [ ""Effect"": ""Allow"", ""Principal"": ""*"", ""Action"": ""s3:getobject"", ""Resource"": [ ""arn:aws:s3::: 您要设置防盗链的桶名字 /*"" ], ""Condition"": ""StringLike"": ""aws:referer"": ["" p:// ] "; PutBucketPolicyRequest putrequest = new PutBucketPolicyRequest BucketName = " 你的桶名 ", Policy = newpolicy client.putbucketpolicy(putrequest); // 获取防盗链设置 GetBucketPolicyRequest getrequest = new GetBucketPolicyRequest BucketName = " 你的桶名 " string policy = client.getbucketpolicy(getrequest).policy; Console.WriteLine(policy); // 删除防盗链设置 DeleteBucketPolicyRequest deleterequest = new DeleteBucketPolicyReq uest BucketName = " 你的桶名 " client.deletebucketpolicy(deleterequest); 4 对象管理

9 对象管理主要涉及到对桶中对象的操作, 主要包括 : 上传对象下载对象查看对象属性复制对象设置对象公开访问 URL 删除对象设置对象访问列表以及设置对象生命周期等根据上传内容的不同可以分为上传本地对象和上传字符串两种, 其中上传对象需要读取本地文件 4.1 上传对象对象存储有多种上传方式, 不同的上传方式能够上传的数据大小也不一样普通上传最多只能上传小于或等于 5GB 的文件 ; 而分片上传每个分片可以打到 5GB, 合并后的文件能够达到 5TB # 桶在哪个数据中心,ServiceURL 填写哪个数据中心的 Endpoint static IAmazonS3 client; client = new AmazonS3Client(Amazon.RegionEndpoint.USEast1); PutObjectRequest request = new PutObjectRequest() FilePath = " 文件路径 " PutObjectResponse response2 = client.putobject(request); 上传字符串 PutObjectRequest request = new PutObjectRequest ContentBody = "This is sample content..." PutObjectResponse response = client.putobject(request); 上传本地文件

10 PutObjectRequest request = new PutObjectRequest BucketName = " 桶的名字 ", FilePath = " 文件路径 " PutObjectResponse response = client.putobject(request); 4.2 分块上传对象分块上传对象是将单个对象进行分块, 分块的大小可以单独进行指定, 但是单个分块最大不超过 5GB 通过分块上传对象, 可以实现超大文件的上传,BC onest 这边支持的所有分块文件的大小不超过 5TB

11 int MB = (int)math.pow(2, 20); Stream inputstream = Create13MBDataStream(); // 分块上传初始化 InitiateMultipartUploadRequest initrequest = new InitiateMultipartU ploadrequest Key = " 对象名字 " InitiateMultipartUploadResponse initresponse = client.initiatemulti partupload(initrequest); // 上传分块文件 1 UploadPartRequest uploadrequest = new UploadPartRequest UploadId = initresponse.uploadid, PartNumber = 1, PartSize = 5 * MB, InputStream = inputstream UploadPartResponse up1response = client.uploadpart(uploadrequest); // 上传分块文件 2 uploadrequest = new UploadPartRequest UploadId = initresponse.uploadid, PartNumber = 2, PartSize = 5 * MB, InputStream = inputstream UploadPartResponse up2response = client.uploadpart(uploadrequest); // 上传分块文件 3 uploadrequest = new UploadPartRequest UploadId = initresponse.uploadid, PartNumber = 3, InputStream = inputstream UploadPartResponse up3response = client.uploadpart(uploadrequest);

12 // 可以通过 ListParts() 函数查看已经完成上传的分块 ListPartsRequest listpartrequest = new ListPartsRequest UploadId = initresponse.uploadid ListPartsResponse listpartresponse = client.listparts(listpartreque st); Debug.Assert(listPartResponse.Parts.Count == 3); // 将多个模块组装成单个文件, 完成分块上传 CompleteMultipartUploadRequest comprequest = new CompleteMultipartU ploadrequest UploadId = initresponse.uploadid, PartETags = new List<PartETag> new PartETag ETag = up1response.etag, PartNumber = 1, new PartETag ETag = up2response.etag, PartNumber = 2, new PartETag ETag = up3response.etag, PartNumber = 3 CompleteMultipartUploadResponse compresponse = client.completemulti partupload(comprequest); 4.3 下载对象

13 GetObjectRequest request = new GetObjectRequest BucketName = " 对象所在的桶 ", Key = " 对象名 " using (GetObjectResponse response = client.getobject(request)) using (StreamReader reader = new StreamReader(response.Response Stream)) string contents = reader.readtoend(); Console.WriteLine("Object - " + response.key); Console.WriteLine(" Version Id - " + response.versionid); Console.WriteLine(" Contents - " + contents); 当桶开启了多版本功能后,client.GetObject 需要参数 VersionId= 对应的版本号 4.4 查看对象属性 GetObjectMetadataRequest request = new Get`ObjectMetadataRequest BucketName = " 对象所在的桶 ", Key = " 对象名 " using (GetObjectMetadataResponse response = client.getobjectmetadat a (request)) using (StreamReader reader = new StreamReader(response.Response Stream)) string contents = reader.readtoend(); Console.WriteLine("Object - " + response.key); Console.WriteLine(" Version Id - " + response.versionid); Console.WriteLine(" Contents - " + contents); 4.5 复制对象

14 CopyObjectRequest request = new CopyObjectRequest SourceBucket = " 桶名字 ", Source DestinationBucket = " 目标桶名字 ", DestinationKey = " 目标对象名字 " client.copyobject(request); 4.6 设置对象公开访问 URL 通过配置相应的参数可以实现不同方式的访问, 获取不同的参数信息以下各个小节中主要示例了五种形式 : 设置获取一个对象 URL 指定请求头 URL 设置获取对应桶的对象列表 URL 设置获取所有者的桶列表 URL 和设置上传对象 URL 等生成预签名的上传对象 URL GetPreSignedUrlRequest request = new GetPreSignedUrlRequest BucketName = " 桶的名字 ", Verb = HttpVerb.PUT, Expires = DateTime.Now.AddDays(10) string path = client.getpresignedurl(request); byte[] data = UTF8Encoding.UTF8.GetBytes("Sample text."); HttpWebRequest httprequest = WebRequest.Create(path) as HttpWebRequ est; httprequest.method = "PUT"; httprequest.contentlength = data.length; Stream requeststream = httprequest.getrequeststream(); requeststream.write(data, 0, data.length); requeststream.close(); HttpWebResponse response = httprequest.getresponse() as HttpWebResp onse; 4.7 删除对象

15 DeleteObjectRequest request = new DeleteObjectRequest BucketName = " 桶的名字 ", Key = " 对象名字 " client.deleteobject(request); 4.8 删除多个对象通过指定多个对象名, 可以实现一次删除多个文件

16 DeleteObjectsRequest request = new DeleteObjectsRequest BucketName = " 桶的名字 ", Objects = new List<KeyVersion> new KeyVersion() Key = "Item1", new KeyVersion() Key = "Item2", VersionId = "Rej8CiBxcZKV K81cLr39j27Y5FVXghDK",, new KeyVersion() Key = "Logs/error.txt" try DeleteObjectsResponse response = client.deleteobjects(request); catch (DeleteObjectsException doe) DeleteObjectsResponse errorresponse = doe.response; foreach (DeletedObject deletedobject in errorresponse.deletedob jects) Console.WriteLine("Deleted item " + deletedobject.key); foreach (DeleteError deleteerror in errorresponse.deleteerrors) Console.WriteLine("Error deleting item " + deleteerror.ke y); Console.WriteLine(" Code - " + deleteerror.code); Console.WriteLine(" Message - " + deleteerror.message); 4.9 设置对象访问列表通过桶的 ACL 来设置桶中的某个对象的被访问权限在以下示例中, 首先指定对象可以被访问, 然后被设置为私有不可公共读写状态

17 client.putacl(new PutACLRequest BucketName = " 桶的名字 ", CannedACL = S3CannedACL.PublicRead // 公开可读 ); client.putacl(new PutACLRequest BucketName = " 桶的名字 ", CannedACL = S3CannedACL.Private // 私有 ); 4.10 设置静态网站 t() PutBucketWebsiteRequest putrequest = new PutBucketWebsiteReques BucketName = "ylybeijing1", WebsiteConfiguration = new WebsiteConfiguration() IndexDocumentSuffix = "index.html", ErrorDocument = "404.jpg" client.putbucketwebsite(putrequest); 4.11 获取静态网站

18 GetBucketWebsiteRequest getrequest = new GetBucketWebsiteRequest() BucketName = " 桶的名字 " GetBucketWebsiteResponse getresponse = client.getbucketwebsite(getr equest); Console.WriteLine("Index document: 0", getresponse.websiteconfigu ration.indexdocumentsuffix); Console.WriteLine("Error document: 0", getresponse.websiteconfigu ration.errordocument); 4.12 删除静态网站 DeleteBucketWebsiteRequest deleterequest = new DeleteBucketWebsiteR equest() BucketName = " 桶的名字 " client.deletebucketwebsite(deleterequest); 静态网站不要和防盗链同时启用, 同时启用后静态网站将不可用, 建议静态网站的资源放到另外一个桶下, 对另外一个桶开启防盗链设置

javascript sdk javascript sdk 列出 Bucket 内的对象上传 textarea 内容到 Bucket 上传本地文件生成私有下载链接生成带过期时间的私有链接删除对象下载对象拷贝对象查看文件访问权限设置文件访问权限获取静态网站配置设置静态网站删除静态网站查询对象元数据查询

javascript sdk javascript sdk 列出 Bucket 内的对象上传 textarea 内容到 Bucket 上传本地文件生成私有下载链接生成带过期时间的私有链接删除对象下载对象拷贝对象查看文件访问权限设置文件访问权限获取静态网站配置设置静态网站删除静态网站查询对象元数据查询桶的多版本 Bucket 开启对象多版本支持挂起 Bucket 的多版本对象功能浏览器客户端浏览器客户端的

S3.Net SDK 文档 1 SDK 说明 对象存储.Net SDK 使用开源的 S3.Net SDK 本文档介绍用户如何使用 S3.Net SDK 来 使用对象存储服务 更加详细的接口参数说明, 请在使用时参照 S3.Net SDK 官方说 明

S3.Net SDK 文档 1 SDK 说明对象存储.Net SDK 使用开源的 S3.Net SDK 本文档介绍用户如何使用 S3.Net SDK 来使用对象存储服务更加详细的接口参数说明, 请在使用时参照 S3.Net SDK 官方说明