平安云 - 云以致用智造未来

.NET SDK

简介 .NET SDK便于.NET平台开发者快速对接使用OBS对象存储服务。在使用之前，您需要确保已经是平安云用户，并且开通了OBS服务。如果您还没有开通或者还不了解平安云 OBS 服务，请登录 <a href="/ssr/products/OBS" target="_blank">OBS产品主页 </a>进行了解。 SDK下载 .NET SDK 开发包最新版本<a href="https://pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/sdk%2Fobs-.NET-sdk-1.0.0.zip?response-content-disposition=attachment%3Bfilename%3Dobs-.NET-sdk-1.0.0.zip" target="_blank"> v1.0.0</a> API概览 <table> <caption> </caption> <thead> <tr> <th> API </th> <th> 描述 </th> </tr> </thead> <tbody> <tr> <td> PutObject </td> <td> OBS .NET SDK 提供了多种文件上传接口，可以通过以下方式上传文件： <ul> <li>文件上传</li> <li>流式上传</li> </ul> </td> </tr> <tr> <td> GetObject </td> <td> 文件下载 </td> </tr> <tr> <td> GetDownloadUrl </td> <td> 获取下载链接 </td> </tr> <tr> <td> DeleteObject </td> <td> 删除文件 </td> </tr> </tbody> </table> API描述 （1）初始化 接口描述 初始化调用OBS服务的对象ObsService，提供三个入参的构造方法。ObsService提供上传、下载、上传文件基本操作。 您需要接入平安云OBS服务，拥有有效的accessKey、secretKey进行签名认证。 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> endpoint </td> <td> String </td> <td> true </td> <td> OBS区域访问地址 </td> <td> - </td> </tr> <tr> <td> accessKey </td> <td> String </td> <td> true </td> <td> OBS租户访问的ak </td> <td> - </td> </tr> <tr> <td> secretKey </td> <td> String </td> <td> true </td> <td> OBS租户访问秘钥 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> ObsService </td> <td> var </td> <td> 实例化对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> <code>var obsService = new ObsService("your endpoint", "your accessKey", "your secretKey");</code></pre> （2）PutObject 接口描述 文件上传 <pre> PutObjectResponse PutObject(String BucketName, String ObjectKey, String FilePath) PutObjectResponse PutObject(String BucketName, String ObjectKey, String FilePath, MetadataCollection Metadata)</pre> 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> String </td> <td> true </td> <td> 保存对象的 bucket 名称 </td> <td> - </td> </tr> <tr> <td> objectKey </td> <td> String </td> <td> true </td> <td> 对象Key，需自行实现策略保证同一bucket下objectKey唯一,不能为空，首字符不能为路径符 </td> <td> - </td> </tr> <tr> <td> filePath </td> <td> String </td> <td> true </td> <td> 上传文件的路径 </td> <td> - </td> </tr> <tr> <td> metadata </td> <td> MetadataCollection </td> <td> false </td> <td> 对象元信息 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> putObjectResult </td> <td> PutObjectResult </td> <td> PutObjectResult返回对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> /*标准文件上传*/ var putObjectResult = obsService.PutObject(BucketName，ObjectKey，FilePath); /*附带文件原信息上传*/ var metaData = new MetadataCollection(); metaData.Add("file_name","test.jpg"); var putObjectResult = obsService.PutObject PutObject(BucketName, ObjectKey, FilePath, metaData);</pre> （3） PutObject 接口描述 流式上传 <pre> PutObjectResponse PutObject(String BucketName, String ObjectKey, Stream InputStream) PutObjectResponse PutObject(String BucketName, String ObjectKey, Stream InputStream, MetadataCollection Metadata)</pre> 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> String </td> <td> true </td> <td> 保存对象的 bucket 名称 </td> <td> - </td> </tr> <tr> <td> objectKey </td> <td> String </td> <td> true </td> <td> 对象Key，需自行实现策略保证同一bucket下objectKey唯一,不能为空，首字符不能为路径符 </td> <td> - </td> </tr> <tr> <td> inputStream </td> <td> Stream </td> <td> true </td> <td> 输入流 </td> <td> - </td> </tr> <tr> <td> metadata </td> <td> MetadataCollection </td> <td> false </td> <td> 对象元信息 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> putObjectResult </td> <td> PutObjectResult </td> <td> PutObjectResult返回对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> /*标准流上传*/ var putObjectResult = obsService.PutObject(BucketName，ObjectKey，InputStream); /*附带流原信息上传*/ var metaData = new MetadataCollection(); metaData.Add("file_name","test.jpg"); var putObjectResult = obsService.PutObject PutObject(BucketName, ObjectKey, InputStream, metaData);</pre> （4） GetObject 接口描述 文件下载 <pre> GetObjectResponse GetObject (String BucketName, String ObjectKey)</pre> 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> String </td> <td> true </td> <td> 保存对象的 bucket 名称 </td> <td> - </td> </tr> <tr> <td> objectKey </td> <td> String </td> <td> true </td> <td> 对象Key，需自行实现策略保证同一bucket下objectKey唯一,不能为空，首字符不能为路径符 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> getObjectResponse </td> <td> GetObjectResponse </td> <td> GetObjectResponse对象 </td> <td> - </td> </tr> </tbody> </table> 实例 <pre> var getObjectResp = os.GetObject(bucketName, keyName);</pre> （5） GetDownloadUrl 接口描述 获取下载链接。 <pre> String GetDownloadUrl(String BucketName, String ObjectKey) String GetDownloadUrl(String BucketName, String ObjectKey, String displayFileName) String GetDownloadUrl(String BucketName, String ObjectKey, String displayFileName, long expiresSeconds)</pre> 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> String </td> <td> true </td> <td> 保存对象的 bucket 名称 </td> <td> - </td> </tr> <tr> <td> objectKey </td> <td> String </td> <td> true </td> <td> 对象Key </td> <td> - </td> </tr> <tr> <td> displayFileName </td> <td> String </td> <td> false </td> <td> 在请求url时，期望云存储服务端返回的content-disposition头信息，默认为null </td> <td> - </td> </tr> <tr> <td> expireSeconds </td> <td> long </td> <td> false </td> <td> url有效秒数，url生成后，在此时间段内有效，过期的url会被云存储拒绝访问，默认为20s </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> url </td> <td> String </td> <td> 已签名的文件下载链接 </td> <td> - </td> </tr> </tbody> </table> （6） DeleteObject 接口描述 删除文件 <pre> DeleteObjectResponse DeleteObject(String BucketName, String ObjectKey)</pre> 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> String </td> <td> true </td> <td> 保存对象的 bucket 名称 </td> <td> - </td> </tr> <tr> <td> objectKey </td> <td> String </td> <td> true </td> <td> 对象Key </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> deleteObjectResponse </td> <td> DeleteObjectResponse </td> <td> DeleteObjectResponse对象 </td> <td> - </td> </tr> </tbody> </table>

以上内容是否解决了您的问题？是否