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

1. 简介

本文档主要介绍 OBS iOS SDK 的接口使用及注意事项；
并且假设您是平安云用户，且已经开通了OBS服务；
如果您还没有开通或者还不了解平安云 OBS 服务，请登录OBS产品主页进行了解。
OBS-iOS-SDK 是由平安云团队开发的工具包。便于开发者在 iOS 上方便使用平安云当中的 OBS 服务。

文档主要罗列了 OBS-iOS-SDK 中，上传、下载以及删除的一些基本方法，并对方法参数进行简要解释，且对响应方法有一个详细的说明。

2. SDK下载

IOS SDK 开发包最新版本 v1.0.3

IOS Demo 下载

3. API概览


API	描述
initWithTokenGeter	初始化服务
initWithBackupHosts	使用备用域名生成上传实例
putFileWithData	上传 data 文件
putFileWithPath	根据路径上传文件
uploadImage	上传图片并压缩
sliceUploadFileWithPath	分片上传文件
downloadWithBucket	下载文件

4. API描述

（1） initWithTokenGeter

接口描述

基础初始化方法

请求参数


参数名称	参数类型	是否必须	参数描述	备注
tokenGeter	IOBSTokenGeter	true	获取token回调	-

响应参数


参数名称	参数类型	参数描述	备注
instancetype	IOBSUploadToken	上传管理类实例	-

（2） initWithBackupHosts

接口描述

使用备用域名生成上传实例

请求参数


参数名称	参数类型	是否必须	参数描述	备注
hosts	NSArray *	true	备用域名池	-
tokenGeter	IOBSTokenGeter	true	获取token回调	-

响应参数


参数名称	参数类型	参数描述	备注
instancetype	IOBSUploadToken	上传管理类实例	-

（3） putFileWithData

接口描述

传 data 文件

请求参数


参数名称	参数类型	是否必须	参数描述	备注
fileData	NSData *	true	获取token回调	-
bucket	NSString *	true	上传到指定 bucket 名称	-
key	NSString *	True	上传对应 bucket 里文件的 key	-
option	IOBSUploadOption *	false	上传时传入的可选参数实现上传文件时候的进度查看	-
baseUrl	NSString *	false	基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com”	-
Complete Handler	IOBSUploadCompletionHandler	false	上传完成后的回调函数	-

响应参数

无

（4） putFileWithPath

接口描述

根据路径上传文件

请求参数


参数名称	参数类型	是否必须	参数描述	备注
path	NSString *	true	上传路径	-
bucket	NSString *	true	上传到指定 bucket 名称	-
key	NSString *	true	上传对应 bucket 里文件的 key	-
option	IOBSUploadOption *	false	上传时传入的可选参数实现上传文件时候的进度查看	-
baseUrl	NSString *	false	基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com”	-
Complete Handler	IOBSUploadCompletionHandler	false	上传完成后的回调函数	-

响应参数

无

（5） uploadImage

接口描述

上传图片并压缩

请求参数


参数名称	参数类型	是否必须	参数描述	备注
image	UIImage *	true	上传图片	-
scale	CGFloat	true	压缩比例(图片尺寸根据比例压缩)	-
bucket	NSString *	true	上传到指定 bucket 名称	bucket
key	NSString *	true	上传对应 bucket 里文件的 key	key
option	IOBSUploadOption *	false	上传时传入的可选参数实现上传文件时候的进度查看	option
baseUrl	NSString *	false	基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com”	baseUrl
Complete Handler	IOBSUploadCompletionHandler	false	上传完成后的回调函数	-

响应参数

无

（6） sliceUploadFileWithPath

接口描述

分片上传文件

请求参数


参数名称	参数类型	是否必须	参数描述	备注
filePath	NSString *	true	上传文件的路径	-
bucket	NSString *	true	上传到指定 bucket 名称	-
key	NSString *	true	上传对应 bucket 里文件的 key	-
option	IOBSUploadOption *	false	上传时传入的可选参数实现上传文件时候的进度查看	-
baseUrl	NSString *	false	基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com”	-
complete Handler	IOBSUploadCompletionHandler	false	上传完成后的回调函数	-

响应参数

无

（7） downloadWithBucket

接口描述

下载文件

请求参数


参数名称	参数类型	是否必须	参数描述	备注
path	NSString *	true	保存路径	-
bucket	NSString *	true	文件所在bucket	-
key	NSString *	true	上传对应 bucket 里文件的 key	-
host	NSString *	true	服务器域名	-
complete Handler	IOBSUploadCompletionHandler	false	上传完成后的回调函数	-

响应参数

无