通过Python SDK V2解冻归档、冷归档和深度冷归档Object

归档、冷归档以及深度冷归档类型的文件需要解冻之后才能读取。文件解冻后，会产生一个标准存储类型的文件副本，即同时存在标准存储类型的文件副本和归档、冷归档或深度冷归档的原文件。在文件解冻的有效期过后，标准存储类型的文件副本会自动删除。本文介绍如何使用OSS Python SDK解冻归档、冷归档以及深度冷归档文件。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要解冻文件，您必须有oss:RestoreObject权限。具体操作，请参见为RAM用户授权自定义的权限策略。

方法定义

restore_object(request: RestoreObjectRequest, **kwargs) → RestoreObjectResult

请求参数列表

参数名	类型	说明

参数名	类型	说明
request	RestoreObjectRequest	设置请求参数，具体请参见RestoreObjectRequest

其中，RestoreObjectRequest的常用参数说明列举如下：

参数名	类型	说明

参数名	类型	说明
bucket	str	存储空间名称
key	str	对象名称
version_id	str	待解冻对象的版本号，如果不设置则默认指定最新版本的对象
restore_request	RestoreRequest	设置解冻请求参数，请参见RestoreRequest

其中，RestoreRequest的参数说明列举如下：

参数名	类型	说明

参数名	类型	说明
days	int	设置解冻持续时间，具体请参见解冻状态持续时间
tier	str	设置解冻消耗时间，具体请参见解冻消耗时间

返回值列表

类型	说明

类型	说明
RestoreObjectResult	返回值，具体请参见RestoreObjectResult

关于解冻文件方法的完整定义，请参见restore_object.py。

示例代码

您可以使用以下代码解冻归档、冷归档或者深度冷归档文件：

import time
import argparse
import alibabacloud_oss_v2 as oss

# 创建一个命令行参数解析器
parser = argparse.ArgumentParser(description="restore object sample")
# 添加需要的命令行参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)

def main():
    # 解析传入的命令行参数
    args = parser.parse_args()

    # 从环境变量加载认证信息
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置
    cfg = oss.config.load_default()
    # 设置认证提供者为环境变量认证
    cfg.credentials_provider = credentials_provider
    # 设置区域
    cfg.region = args.region
    # 如果提供了endpoint，则设置endpoint为配置项
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 创建OSS客户端
    client = oss.Client(cfg)

    # 执行解冻对象请求
    result = client.restore_object(oss.RestoreObjectRequest(
        bucket=args.bucket,
        key=args.key,
        restore_request=oss.RestoreRequest(
            days=1,
            # 可选：设置冷归档、深度冷归档对象的解冻优先级，可设置为:Expedited、Standard、Bulk，默认值为Standard
            # tier="Bulk",
        )
    ))

    # 打印解冻请求的结果
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
          f' restore priority: {result.restore_priority},'
    )

    # 循环检查对象是否已经完成解冻
    while True:
        # 获取对象头部信息
        result = client.head_object(oss.HeadObjectRequest(
            bucket=args.bucket,
            key=args.key,
        ))

        # 检查解冻状态
        if result.restore and result.restore != 'ongoing-request="true"':
            print('restore is success')
            break
        # 5秒后再次检查
        time.sleep(5)
        print(result.restore)

# 程序入口
if __name__ == "__main__":
    main()

Python解冻文件

注意事项

方法定义

请求参数列表

返回值列表

示例代码

相关文档