归档或冷归档类型的文件需要解冻(Restore)之后才能读取。本文介绍如何解冻归档和冷归档文件。

说明 非归档或冷归档类型的文件,不要调用RestoreObject方法。

归档及冷归档类型的详细说明请参见存储类型介绍。相关状态码的详细解释请参见API文档RestoreObject

解冻归档文件

归档类型的Object在执行解冻前后的状态变换过程如下:

  1. 归档类型的Object初始时处于冷冻状态。
  2. 提交一次解冻请求后,Object处于解冻中的状态,完成解冻任务通常需要1分钟。
  3. 服务端完成解冻任务后,Object进入解冻状态,此时您可以读取Object。解冻状态默认持续24小时,24小时内再次调用RestoreObject接口则解冻状态会自动延长24小时。对于同份归档文件,一次解冻流程内可有效调用7次RestoreObject接口达到最长7天的解冻持续时间。
  4. 解冻状态结束后,Object再次返回到冷冻状态。

解冻归档文件的完整代码请参见GitHub

以下代码用于解冻归档文件:

// Endpoint以杭州为例,其它Region请按实际情况填写。
String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
// 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录RAM控制台创建RAM账号。
String accessKeyId = "<yourAccessKeyId>";
String accessKeySecret = "<yourAccessKeySecret>";

String bucketName = "<yourBucketName>";
String objectName = "<yourObjectName>";

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

ObjectMetadata objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);

// 校验文件是否为归档文件。
StorageClass storageClass = objectMetadata.getObjectStorageClass();
if (storageClass == StorageClass.Archive) {
    // 解冻文件。
    ossClient.restoreObject(bucketName, objectName);

    // 等待解冻完成。
    do {
        Thread.sleep(1000);
        objectMetadata = ossClient.getObjectMetadata(bucketName, objectName);
    } while (!objectMetadata.isRestoreCompleted());
}

// 获取解冻文件。
OSSObject ossObject = ossClient.getObject(bucketName, objectName);
ossObject.getObjectContent().close();

// 关闭OSSClient。
ossClient.shutdown();

解冻冷归档文件

冷归档类型的Object在执行解冻前后的状态变换过程如下:

  1. 冷归档类型的Object初始时处于冷冻状态。
  2. 提交一次解冻请求后,Object处于解冻中的状态。不同优先级的首字节取回时间如下:
    • 高优先级(Expedited):表示1小时内完成解冻。
    • 标准(Standard):表示2~5小时内完成解冻。如果不传入JobParameters节点,则默认为Standard。
    • 批量(Bulk):表示5~12小时内完成解冻。
  3. 服务端完成解冻任务后,Object进入解冻状态,此时您可以读取Object。您可以指定解冻的天数,最短是1天,最长是7天。
  4. 解冻状态结束后,Object再次返回到冷冻状态。

以下代码用于解冻冷归档文件:

// Endpoint以杭州为例,其它Region请按实际情况填写。
String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
// 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录RAM控制台创建RAM账号。
String accessKeyId = "<yourAccessKeyId>";
String accessKeySecret = "<yourAccessKeySecret>";
String bucketName = "<yourBucketName>";
String objectName = "<yourColdArchiveObjectName>";

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

// 如需创建冷归档类型的文件,请参考以下代码。
// 创建PutObjectRequest对象。
// PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, new ByteArrayInputStream("<yourContent>".getBytes()));
// 在metadata中指定文件的存储类型为冷归档类型。
// ObjectMetadata metadata = new ObjectMetadata();
// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.ColdArchive.toString());
// putObjectRequest.setMetadata(metadata);
// 上传文件的同时设置文件的存储类型。
// ossClient.putObject(putObjectRequest);

// 设置解冻冷归档文件的优先级。
// RestoreTier.RESTORE_TIER_EXPEDITED 表示1小时内完成解冻。
// RestoreTier.RESTORE_TIER_STANDARD 表示2~5小时内完成解冻。
// RestoreTier.RESTORE_TIER_BULK 表示5~12小时内完成解冻。
RestoreJobParameters jobParameters = new RestoreJobParameters(restoreTier);

// 配置解冻参数,以设置5小时内解冻完成,解冻状态保持2天为例。
// 第一个参数表示保持解冻状态的天数,默认是1天,此参数适用于解冻Archive(归档)与ColdArchive(冷归档)类型文件。
// 第二个参数jobParameters表示解冻优先级,只适用于解冻ColdArchive类型文件。
RestoreConfiguration configuration = new RestoreConfiguration(2, jobParameters);

// 发起解冻请求。
ossClient.restoreObject(bucketName, objectName, configuration);

// 关闭ossClient。
ossClient.shutdown();