归档或冷归档类型的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:
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// 填写Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 填写不包含Bucket名称在内的归档类型Object的完整路径。
String objectName = "exampledir/object";
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
try {
ObjectMetadata objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);
// 校验Object是否为归档类型Object。
StorageClass storageClass = objectMetadata.getObjectStorageClass();
if (storageClass == StorageClass.Archive) {
// 解冻Object。
ossClient.restoreObject(bucketName, objectName);
// 等待解冻完成。
do {
Thread.sleep(1000);
objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);
} while (!objectMetadata.isRestoreCompleted());
}
// 获取解冻Object。
OSSObject ossObject = ossClient.getObject(bucketName, objectName);
ossObject.getObjectContent().close();
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
解冻冷归档Object
以下代码用于解冻冷归档Object:
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// 填写Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 填写不包含Bucket名称在内的冷归档类型Object的完整路径。
String objectName = "exampledir/object";
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
try {
// 如需创建冷归档类型的Object,请参考以下代码。
// 创建PutObjectRequest对象。
// PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, new ByteArrayInputStream("<yourContent>".getBytes()));
// 在metadata中指定Object的存储类型为冷归档类型。
// ObjectMetadata metadata = new ObjectMetadata();
// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.ColdArchive.toString());
// putObjectRequest.setMetadata(metadata);
// 上传Object的同时设置Object的存储类型。
// ossClient.putObject(putObjectRequest);
// 设置解冻冷归档Object的优先级。
// RestoreTier.RESTORE_TIER_EXPEDITED 表示1小时内完成解冻。
// RestoreTier.RESTORE_TIER_STANDARD 表示2~5小时内完成解冻。
// RestoreTier.RESTORE_TIER_BULK 表示5~12小时内完成解冻。
RestoreJobParameters jobParameters = new RestoreJobParameters(RestoreTier.RESTORE_TIER_EXPEDITED);
// 配置解冻参数,以设置5小时内解冻完成,解冻状态保持2天为例。
// 第一个参数表示保持解冻状态的天数,默认是1天,此参数适用于解冻Archive(归档)与ColdArchive(冷归档)类型Object。
// 第二个参数jobParameters表示解冻优先级,只适用于解冻ColdArchive类型Object。
RestoreConfiguration configuration = new RestoreConfiguration(2, jobParameters);
// 发起解冻请求。
ossClient.restoreObject(bucketName, objectName, configuration);
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
相关文档
- 关于解冻归档和冷归档Object的完整示例代码,请参见GitHub示例。
- 关于解冻归档和冷归档Object的API接口说明,请参见RestoreObject。