文档首页/ 对象存储服务 OBS/ SDK参考/ iOS/ 上传对象/ 断点续传上传设置上传回调
更新时间：2025-09-17 GMT+08:00
查看PDF
分享

断点续传上传设置上传回调

功能说明

您可以在断点续传上传请求（uploadFile）中设置回调参数，OBS在对象上传成功之后，将上传结果回调特定服务器，并将回调结果返回给您。

方法定义

1
2
 
- (OBSBFTask*)uploadFile:(OBSUploadFileRequest *)request
         completionHandler:(void (^)(OBSUploadFileResponse  * response, NSError * error))completionHandler;

请求参数说明

表1 OBSUploadFileRequest

参数名称

参数类型

是否必选

描述

bucketName

NSString *

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

NSString *

必选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

uploadFilePath

NSString *

必选

参数解释：

待上传对象的文件。

默认取值：

无

enableCheckpoint

BOOL

必选

参数解释：

是否开启断点续传模式。

取值范围：

  • YES：开启断点续传模式。
  • NO：关闭断点续传模式。

默认取值：

NO

checkpointFilePath

NSString *

可选

参数解释：

断点续传过程中，会生成一个进度记录文件，文件中会记录段的上传进度和段的相关信息。checkpointFile参数为该记录文件的文件路径。

约束限制：

仅在开启断点续传模式时有效。

partSize

NSNumber *

必选

参数解释：

分段大小。

取值范围：

100KB~5GB，单位：字节。

默认取值：

5MB

callBack

OBSCallBack *

可选

参数解释：

上传回调相关参数。

取值范围：

详见OBSCallBack。

默认取值：

无
表2 OBSCallBack

参数名称

参数类型

是否必选

描述

callbackUrl

NSString *

必选

参数解释：

对象上传成功之后，OBS向此url发送回调请求，请求方法为POST。

约束限制：

  • 最多支持设置10个url，以英文分号（;）分隔。
  • callbackUrl需要做url编码。例如：“http://www.example.com/中文?key=中文名”需要编码成“http://www.example.com/%E4%B8%AD%E6%96%87?key=%E4%B8%AD%E6%96%87%E5%90%8D”。

callbackHost

NSString *

可选

参数解释：

发起回调请求的Host头域的值。

约束限制：

如果不设置callbackHost的值，会使用callbackUrl解析出来的Host。

callbackBody

NSString *

必选

参数解释：

发起回调请求的body体。

约束限制：

body体格式必须符合callbackBodyType中设置的媒体类型。

默认取值：

回调body体支持系统变量和自定义变量，系统变量如回调body体支持的系统变量所示，自定义变量就是以x:开头的变量。例如：key=$(key)&hash=$(etag)&fileid=$(x:fileid)，其中变量key、etag是系统变量，x:fileid是自定义变量。如果用户上传的对象是图片，可以在参数中设置imageInfo.width和imageInfo.height表示该图片的宽高。例如：key=$(key)&hash=$(etag)&w=$(imageInfo.width)&h=$(imageInfo.height)。

callbackBodyType

NSString *

可选

参数解释：

发起回调请求的Content-Type头域的值。

取值范围：

  • application/x-www-form-urlencoded
  • application/json

默认取值：

如果不设置，默认为application/json。

返回结果说明

表3 OBSUploadFileResponse

参数名称

参数类型

描述

statusCode

NSString *

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。

完整的状态码列表请参见状态码。

默认取值：

无

headers

NSDictionary *

参数解释：

响应消息头列表，由多个元组构成。

默认取值：

无

etag

NSString *

参数解释：

对象的etag值，即Base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。

约束限制：

当对象是服务端加密的对象时，etag值不是对象的MD5值。

取值范围：

长度为32的字符串。

默认取值：

无

responseRawData

NSMutableData *

参数解释：

响应体的原始数据。

默认取值：

无

代码示例

此示例用于断点续传上传（uploadFile）时设置上传回调： 
void testPutObjectWithCallback(){
//    NSString *endPoint = @"your-endpoint";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey
    // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    NSString* endPoint = @"https://obs.cn-north-4.myhuaweicloud.com";
    char* ak_env = getenv("AccessKeyID");
    char* sk_env = getenv("SecretAccessKey");
    char* securityToken_env = getenv("SecurityToken");
    NSString *AK = [NSString stringWithUTF8String:ak_env];
    NSString *SK = [NSString stringWithUTF8String:sk_env];
    NSString* securityToken = [NSString stringWithUTF8String:securityToken_env];
    NSString* exampleBucketName = @"example-bucket-name";
    NSString* exampleObjectKey = @"objectname.pic";
    NSString* exampleFile = [[NSBundle mainBundle]pathForResource:@"pic" ofType:@"jpeg"];//@"";
    NSString* exampleCallbackUrl = @"www.example-url.com";
    NSString* exampleCallbackBody = @"exampleCallbackBody";
    NSString* exampleCallbackHost = @"www.example-host.com";
    NSString* exampleCallbackBodyType = @"example-content-type";
    // 初始化身份验证
    OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK];
    // 【可选】如果使用临时AKSK和SecurityToken访问OBS，需要指定securityToken值
    // credentialProvider.securityToken = securityToken;
    // 初始化服务配置
    OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider];
    // 初始化client
    OBSClient *client = [[OBSClient alloc] initWithConfiguration:conf];
    // 初始化上传对象请求putObjectRequest
    OBSUploadFileRequest* uploadFileRequest = [[OBSUploadFileRequest alloc] initWithBucketName:exampleBucketName objectKey:exampleObjectKey uploadFilePath:exampleFile];
    uploadFileRequest.partSize = [NSNumber numberWithInteger: 100 * 1024];
    uploadFileRequest.callback = [[OBSCallback alloc] initWithUrl:exampleCallbackUrl withBody:exampleCallbackBody withBodyType:exampleCallbackBodyType withHost:exampleCallbackHost];
    // 初始化上传对象异步任务
    OBSBFTask* uploadFileTask = [client uploadFile:uploadFileRequest completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
        if(error){
            // 上传失败
            NSLog(@"UploadFile failed:%@", error);
        }
        if(response){
            NSLog(@"UploadFile response:%@", response);
            NSString* callbackResponseString = [[NSString alloc] initWithData:response.responseRawData
                                                                     encoding:NSUTF8StringEncoding];
            NSLog(@"UploadFile callbackResponseString:%@", callbackResponseString);
        }
    }];
    // 等待上传对象异步任务完成
    [uploadFileTask waitUntilFinished];
}
父主题： 上传对象

相关文档