恢复归档或深度归档存储对象(Python SDK)
功能说明
归档要先将对象恢复，然后再执行下载数据的操作。对象恢复后，会产生一个标准存储类型的对象副本，也就是说会同时存在标准存储类型的对象副本和归档或深度归档存储对象，在恢复对象的保存时间到期后标准存储类型的对象副本会自动删除。
该接口可以恢复指定桶中的归档或深度归档存储对象。
接口约束
- 您必须是桶拥有者或拥有恢复对象的权限，才能恢复对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:RestoreObject权限，如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
- 归档和深度归档对象恢复的有效期时长上限为30天。
- 冷存储的对象正在恢复的过程中，不支持修改恢复方式，不允许暂停或删除恢复任务。
- 归档存储或深度归档存储的对象正在恢复的过程中，不支持修改恢复方式，不允许暂停或删除恢复任务。
- 对象的恢复状态为恢复中时，对象不能再次恢复，接口会报错409，请对象恢复完成后再进行恢复操作。
- 恢复中的对象不能加入批量恢复文件中。
方法定义
ObsClient.restoreObject(bucketName, objectKey, days, tier, versionId, extensionHeaders)
请求参数
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| bucketName | str | 必选 | 参数解释： 桶名。 约束限制：
默认取值： 无 |
| objectKey | str | 必选 | 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 |
| days | int | 必选 | 参数解释： 恢复对象后，会生成一个对象的标准存储副本，此参数指定恢复有效期，即标准存储副本的保存时间。 取值范围： [1, 30]，单位：天。 默认取值： 无 |
| tier | str | 可选 | 参数解释： 恢复选项，用户可根据需求选择恢复选项，不同的恢复选项恢复耗时不同。 取值范围： 恢复选项可选值详见恢复选项。 默认取值： 标准恢复 |
| versionId | str | 可选 | 参数解释： 默认取值： 无，如果不设置则默认指定最新版本的对象。 |
| extensionHeaders | dict | 可选 | 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无 |
返回结果
| 类型 | 说明 |
|---|---|
| 参数解释： SDK公共结果对象。 |
如果GetResult.status为202表示正在恢复对象；如果GetResult.status为200表示对象已恢复。
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| status | int | 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 |
| reason | str | 参数解释： HTTP文本描述。 默认取值： 无 |
| errorCode | str | 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 |
| errorMessage | str | 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 |
| requestId | str | 参数解释： OBS服务端返回的请求ID。 默认取值： 无 |
| indicator | str | 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 |
| hostId | str | 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 |
| resource | str | 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 |
| header | list | 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 |
| body | object | 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 |
代码样例（恢复指定对象）
本示例用于恢复归档或深度归档存储对象objectname。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | import os import traceback from obs import ObsClient, RestoreTier # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv('AccessKeyID') sk = os.getenv('SecretAccessKey') # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv('SecurityToken') # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = 'https://obs.cn-north-4.myhuaweicloud.com' # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: bucket_name = 'examplebucket' object_key = 'objectname' # 恢复对象的保存时间（单位：天），取值范围：1~30 days = 1 # 恢复选项RestoreTier，可选值EXPEDITED/STANDARD tier = RestoreTier.EXPEDITED # 恢复归档或深度归档存储对象 resp = obs_client.restoreObject(bucket_name, object_key, days, tier) # 返回码为2xx时，接口调用成功，否则接口调用失败 if resp.status < 300: print('Restore Object Succeeded') print('requestId:', resp.requestId) else: print('Restore Object Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: print('Restore Object Failed') print(traceback.format_exc()) |
代码样例二（恢复指定路径）
本示例用于恢复example/路径下所有归档或深度归档存储对象。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | import os import traceback from obs import ObsClient, RestoreTier # 推荐通过环境变量获取AK/SK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv('AccessKeyID') sk = os.getenv('SecretAccessKey') # 如需使用临时AK/SK和SecurityToken访问OBS，则同样推荐通过环境变量获取 # security_token = os.getenv('SecurityToken') # server填写Bucket对应的Endpoint，这里以华北-北京四为例，其他地区请按实际情况填写 server = 'https://obs.cn-north-4.myhuaweicloud.com' # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) bucket_name = 'examplebucket' # 恢复对象的保存时间（单位：天），取值范围：1~30 days = 1 # 恢复选项RestoreTier，可选值EXPEDITED/STANDARD tier = RestoreTier.EXPEDITED max_num = 1000 mark = None try: while True: resp = obs_client.listObjects(bucket_name, prefix='example', max_keys=max_num, encoding_type='url') if resp.status < 300: print('requestId:', resp.requestId) print('is_truncated:', resp.body.is_truncated) for content in (resp.body.contents or []): if content.storageClass in ('COLD', 'DEEP_ARCHIVE'): try: print('object_key:{0}'.format(content.key)) object_key = content.key # 恢复归档存储对象 restore_resp = obs_client.restoreObject(bucket_name, object_key, days, tier) # 返回码为2xx时，接口调用成功，否则接口调用失败 if restore_resp.status < 300: print('Restore Object Succeeded') print('requestId:', restore_resp.requestId) if restore_resp.status == 200: print('Object already restored') elif restore_resp.status == 202: print('Object is being restored, please wait') elif restore_resp.status == 409: print('Restore already in progress') else: print('Restore Object Failed') print('requestId:', restore_resp.requestId) print('errorCode:', restore_resp.errorCode) print('errorMessage:', restore_resp.errorMessage) except Exception: print('Restore Object Failed') print(traceback.format_exc()) if resp.body.is_truncated: mark = resp.body.next_marker else: break else: print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) break except Exception: print(traceback.format_exc()) |
相关链接
- 关于恢复归档存储对象的API说明，请参见恢复归档或深度归档存储对象。
- 更多关于恢复归档存储对象的示例代码，请参见Github示例。
- 恢复归档存储对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
