通过断点续传上传的方式将文件上传到OSS前,您可以指定断点记录点。上传过程中,如果出现网络异常或程序崩溃导致文件上传失败时,将从断点记录处继续上传未上传完成的部分。
注意事项
- 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见 访问域名和数据中心 。
- 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见 新建OssClient 。
-
要断点续传上传,您必须有
oss:PutObject权限。具体操作,请参见 为RAM用户授权自定义的权限策略 。 -
使用断点续传上传时,文件上传的进度信息会记录在Checkpoint文件中,如果上传过程中某一分片上传失败,再次上传时会从Checkpoint文件中记录的点继续上传,从而达到断点续传的效果。上传完成后,Checkpoint文件会被删除。
-
SDK会将上传的状态信息记录在Checkpoint文件中,所以要确保程序对Checkpoint文件有写权限。
-
请勿修改Checkpoint文件中携带的校验信息。如果Checkpoint文件损坏,则会重新上传所有分片。
-
如果上传过程中本地文件发生了改变,则会重新上传所有分片。
实现方法
您可以通过client.ResumableUploadObject方法实现断点续传上传。此方法中的UploadObjectRequest请求包含以下参数:
|
参数 |
描述 |
是否必须 |
默认值 |
设置方法 |
|
bucket |
存储空间名称。 |
是 |
无 |
通过构造方法设置 |
|
key |
上传到OSS的文件名称。 |
是 |
无 |
|
|
filePath |
上传的本地文件名称。 |
否 |
无 |
|
|
partSize |
上传的分片大小,取值范围为100 KB~5 GB。 |
否 |
8 MB |
通过setPartSize设置 |
|
threadNum |
分片上传的并发数。 |
否 |
3 |
通过构造函数或者setThreadNum设置 |
|
checkpointDir |
记录本地分片上传结果的文件。上传过程中的进度信息会保存在该文件中,如果某一分片上传失败,再次上传时会根据文件中记录的点继续上传。上传完成后,该文件会被删除。 |
否 |
与DownloadFile同目录 |
通过构造函数或者setCheckpointDir设置 |
示例代码
以下代码用于断点续传上传。
#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
/* 初始化OSS账号信息。*/
/* yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
std::string Endpoint = "yourEndpoint";
/* 填写Bucket名称,例如examplebucket。*/
std::string BucketName = "examplebucket";
/* 填写Object的完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。*/
std::string ObjectName = "exampledir/exampleobject.txt";
/* 填写本地文件的完整路径,例如D:\\localpath\\examplefile.txt。如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件。*/
std::string UploadFilePath = "D:\\localpath\\examplefile.txt";
/* 记录本地分片上传结果的文件。上传过程中的进度信息会保存在该文件中,如果某一分片上传失败,再次上传时会根据文件中记录的断点继续上传。上传完成后,该文件会被删除。*/
/* 设置断点记录文件所在的目录,并确保指定的目录已存在,例如D:\\local。如果未设置该值,默认与待上传的本地文件同路径。*/
std::string CheckpointFilePath = "D:\\local";
/* 初始化网络等资源。*/
InitializeSdk();
ClientConfiguration conf;
/* 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
OssClient client(Endpoint, credentialsProvider, conf);
/* 断点续传上传。*/
UploadObjectRequest request(BucketName, ObjectName, UploadFilePath, CheckpointFilePath);
auto outcome = client.ResumableUploadObject(request);
if (!outcome.isSuccess()) {
/* 异常处理。*/
std::cout << "ResumableUploadObject fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
return -1;
/* 释放网络等资源。*/
ShutdownSdk();
return 0;
}
相关文档
关于断点续传上传的完整代码,请参见 GitHub示例 。