归档或冷归档类型的Object需要解冻(Restore)之后才能读取。本文介绍如何解冻归档和冷归档Object。
重要 非归档或非冷归档类型的Object,请勿调用RestoreObject方法。
注意事项
- 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心。
- 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见新建OssClient。
- 要解冻文件,您必须有
oss:RestoreObject
权限。具体操作,请参见为RAM用户授权自定义的权限策略。
解冻过程说明
对于归档类型或者冷归档类型的Object,如果需要读取Object,请提前解冻。归档类型Object解冻完成通常需要数分钟,冷归档类型Object根据不同解冻优先级,解冻完成通常需要数小时,请以实际解冻时间为准。
归档类型或者冷归档类型的Object在执行解冻前后的状态变换过程如下:
- Object初始时处于冷冻状态。
- 提交一次解冻请求后,Object处于解冻中状态。
- 服务端完成解冻任务后,Object进入解冻状态,此时您可以读取Object。
- 归档类型Object
对于归档类型的Object,解冻状态默认持续24小时,24小时内再次调用RestoreObject接口则解冻状态会自动延长24小时,一次解冻流程内可有效调用7次RestoreObject接口达到最长7天的解冻持续时间。您也可以通过传入解冻天数,一次调用RestoreObject接口指定最长7天的解冻持续时间。
- 冷归档类型Object对于冷归档类型的Object,您可以指定解冻天数和解冻优先级,解冻天数最短为1天,最长为365天。不同解冻优先级的首字节取回时间如下:
- 高优先级(Expedited):表示1小时内完成解冻。
- 标准(Standard):表示2~5小时内完成解冻。如果不传入JobParameters节点,则默认为Standard。
- 批量(Bulk):表示5~12小时内完成解冻。
单个阿里云账号在单个地域的取回量参考值:平均每秒500个Object,三种解冻优先级总取回量为每天100 TB~120 TB。
- 归档类型Object
- 解冻状态结束后,Object再次返回到冷冻状态。
解冻归档Object
以下代码用于解冻归档Object:
#include <alibabacloud/oss/OssClient.h>
#include <thread>
#include <chrono>
using namespace AlibabaCloud::OSS;
int main(void)
{
/*初始化OSS账号信息。*/
/*阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。*/
std::string AccessKeyId = "yourAccessKeyId";
std::string AccessKeySecret = "yourAccessKeySecret";
/*yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
std::string Endpoint = "yourEndpoint";
/*填写Bucket名称,例如examplebucket。*/
std::string BucketName = "examplebucket";
/*填写不包含Bucket名称在内的归档类型Object的完整路径。*/
std::string ObjectName = "yourObjectName";
/*初始化网络等资源。*/
InitializeSdk();
ClientConfiguration conf;
OssClient client(Endpoint, AccessKeyId, AccessKeySecret, conf);
/*解冻归档Object。*/
auto outcome = client.RestoreObject(BucketName, ObjectName);
/*非归档Object不能解冻。*/
if (!outcome.isSuccess()) {
/*异常处理。*/
std::cout << "RestoreObject fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
ShutdownSdk();
return -1;
}
std::string onGoingRestore("ongoing-request=\"false\"");
int maxWaitTimeInSeconds = 600;
while (maxWaitTimeInSeconds > 0)
{
auto meta = client.HeadObject(BucketName, ObjectName);
std::string restoreStatus = meta.result().HttpMetaData()["x-oss-restore"];
std::transform(restoreStatus.begin(), restoreStatus.end(), restoreStatus.begin(), ::tolower);
if (!restoreStatus.empty() &&
restoreStatus.compare(0, onGoingRestore.size(), onGoingRestore)==0) {
std::cout << " success, restore status:" << restoreStatus << std::endl;
/*成功解冻归档Object。*/
break;
}
std::cout << " info, WaitTime:" << maxWaitTimeInSeconds
<< "; restore status:" << restoreStatus << std::endl;
std::this_thread::sleep_for(std::chrono::seconds(10));
maxWaitTimeInSeconds--;
}
if (maxWaitTimeInSeconds == 0)
{
std::cout << "RestoreObject fail, TimeoutException" << std::endl;
}
/*释放网络等资源。*/
ShutdownSdk();
return 0;
}
解冻冷归档Object
以下代码用于解冻冷归档Object:
#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
{
/*初始化OSS账号信息。*/
/*阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。*/
std::string AccessKeyId = "yourAccessKeyId";
std::string AccessKeySecret = "yourAccessKeySecret";
/*yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
std::string Endpoint = "yourEndpoint";
/*填写Bucket名称,例如examplebucket。*/
std::string BucketName = "examplebucket";
/*填写不包含Bucket名称在内的冷归档类型Object的完整路径。*/
std::string ObjectName = "yourObjectName";
/*初始化网络等资源。*/
InitializeSdk();
ClientConfiguration conf;
OssClient client(Endpoint, AccessKeyId, AccessKeySecret, conf);
/*如果上传文件的同时指定文件存储类型为冷归档,请参考如下代码。*/
//auto content = std::make_shared<std::stringstream>("test");
//PutObjectRequest putRequest(BucketName, ObjectName, content);
//putRequest.MetaData().addHeader("x-oss-storage-class", "ColdArchive");
//auto putOutcome = client.PutObject(putRequest);
RestoreObjectRequest request(BucketName, ObjectName);
/*设置解冻之后保持解冻状态的天数,默认值为1天。*/
request.setDays(2);
/*设置解冻冷归档类型文件的优先级。TierType::Expedited表示1个小时之内解冻完成。*/
request.setTierType(TierType::Expedited);
auto outcome = client.RestoreObject(request);
if (!outcome.isSuccess()) {
/*异常处理。*/
std::cout << "Delete Bucket Inventory fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
}
/*释放网络等资源。*/
ShutdownSdk();
return 0;
}
相关文档
- 关于解冻归档和冷归档类型Object的完整示例代码,请参见GitHub示例。
- 关于解冻归档和冷归档Object的API接口说明,请参见RestoreObject。