恢复归档或深度归档存储对象
功能说明
归档要先将对象恢复,然后再执行下载数据的操作。对象恢复后,会产生一个标准存储类型的对象副本,也就是说会同时存在标准存储类型的对象副本和归档或深度归档存储对象,在恢复对象的保存时间到期后标准存储类型的对象副本会自动删除。
该接口可以恢复指定桶中的归档或深度归档存储对象。
重复恢复归档存储数据时在延长恢复有效期的同时,也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长,并且收取延长时间段产生的标准存储副本费用。
接口约束
- 您必须是桶拥有者或拥有恢复归档存储对象的权限,才能恢复归档存储对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:RestoreObject权限,如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 重复恢复归档存储数据时在延长恢复有效期的同时,也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长,并且收取延长时间段产生的标准存储副本费用。
方法定义
ObsClient.restoreObject(params)
请求参数
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | str | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| Key | str | 必选 | 参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
| VersionId | str | 可选 | 参数解释: 默认取值: 无,如果不设置则默认指定最新版本的对象。 |
| Days | int | 必选 | 参数解释: 恢复对象后,会生成一个对象的标准存储副本,此参数指定恢复有效期,即标准存储副本的保存时间。 取值范围: [1, 30],单位:天。 默认取值: 无 |
| Tier | str | 可选 | 参数解释: 恢复选项,用户可根据需求选择恢复选项,不同的恢复选项恢复耗时不同。 取值范围:
默认取值: 无 |
返回结果
| 类型 | 说明 |
|---|---|
| 参数解释: SDK公共结果对象。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| 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。
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 前端本身没有process对象,可以使用webpack类打包工具定义环境变量,就可以在代码中运行了。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
const AK = process.env.AccessKeyID
const SK = process.env.SecretAccessKey
// 【可选】如果使用临时AKSK和SecurityToken访问OBS,则同样推荐通过环境变量获取
const security_token= process.env.SecurityToken
// server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。
const server = "https://obs.cn-north-4.myhuaweicloud.com"
// 创建ObsClient实例
var obsClient = new ObsClient({
access_key_id: AK,
secret_access_key: SK,
server: server
});
async function restoreObject() {
try {
const params = {
Bucket: 'examplebucket',
Key: 'objectname',
// 多版本场景下指定某一个版本
// VersionId: '',
// 恢复有效期,即标准存储副本的保存时间,取值范围[1, 30],单位:天
Days: 1,
// 快速恢复,标准速度为:Standard
Tier: "Expedited"
};
// 设置对象标签
const result = await obsClient.restoreObject(params);
if (result.CommonMsg.Status <= 300) {
console.log("Restore object(%s)'s tagging successful!", params.Key);
console.log("RequestId: %s", result.CommonMsg.RequestId);
return;
};
console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
console.log("Status: %d", result.CommonMsg.Status);
console.log("Code: %s", result.CommonMsg.Code);
console.log("Message: %s", result.CommonMsg.Message);
console.log("RequestId: %s", result.CommonMsg.RequestId);
} catch (error) {
console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
console.log(error);
};
};
restoreObject()