文档

解冻文件

更新时间:

在受版本控制的存储空间(Bucket)中,Object的各个版本可以对应不同的存储类型。RestoreObject接口默认解冻Object的当前版本,允许通过指定versionId的方式来解冻指定版本的Object。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见Java配置访问凭证

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见新建OSSClient

  • 要解冻文件,您必须有oss:RestoreObject权限。具体操作,请参见为RAM用户授权自定义的权限策略

示例代码

以下代码用于解冻文件:

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
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";
        // 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // 填写Bucket名称,例如examplebucket。
        String bucketName = "examplebucket";
        // 填写Object的完整路径。Object完整路径中不能包含Bucket名称。
        String objectName = "exampledir/object";
        // 指定归档、冷归档或者深度冷归档类型文件的versionId。
        String versionId = "CAEQMxiBgICAof2D0BYiIDJhMGE3N2M1YTI1NDQzOGY5NTkyNTI3MGYyMzJm****";

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

        try {
            // 获取指定versionId文件的部分元数据。
            GenericRequest getObjectMetadataRequest = new GenericRequest(bucketName,objectName, versionId);
            ObjectMetadata objectMetadata = ossClient.getObjectMetadata(getObjectMetadataRequest);

            // 校验指定versionId文件是否为归档、冷归档或者深度冷归档类型。
            StorageClass storageClass = objectMetadata.getObjectStorageClass();
            System.out.println("object storage class:" + objectMetadata.getObjectStorageClass());
            if (storageClass == StorageClass.Archive) {
                // 解冻文件。
                GenericRequest genericRequest = new GenericRequest(bucketName, objectName, versionId);
                RestoreObjectResult restoreObjectResult = ossClient.restoreObject(genericRequest);
                System.out.println("restor versionid: " + restoreObjectResult.getVersionId());

                // 等待解冻完成。
                do {
                    Thread.sleep(1000);
                    objectMetadata = ossClient.getObjectMetadata(getObjectMetadataRequest);
                    System.out.println("is competed:" + objectMetadata.isRestoreCompleted());
                } while (!objectMetadata.isRestoreCompleted());
            }

            // 指定versionId解冻文件。
            GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, objectName);
            getObjectRequest.setVersionId(versionId);
            OSSObject ossObject = ossClient.getObject(getObjectRequest);
            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();
            }
        }
    }
}

相关文档

关于解冻文件的API接口说明,请参见RestoreObject