更新时间:2024-11-13 GMT+08:00

下载归档存储对象(Node.js SDK)

开发过程中,您有任何问题可以在github上提交issue

重复恢复归档存储数据时在延长恢复有效期的同时,也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长,并且收取延长时间段产生的标准存储副本费用。

功能说明

如果要获取归档存储对象的内容,需要先将对象恢复,然后再执行下载数据的操作。对象恢复后,会产生一个标准存储类别的对象副本,也就是说会同时存在标准存储类型的对象副本和归档存储对象,在恢复对象的保存时间到期后标准存储类型的对象副本会自动删除。

该接口可以恢复指定桶中的归档存储对象。

接口约束

  • 您必须是桶拥有者或拥有恢复归档存储对象的权限,才能恢复归档存储对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:RestoreObject权限,如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 重复恢复归档存储对象时在延长恢复有效期的同时,也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长,并且收取延长时间段产生的标准存储副本费用。

方法定义

ObsClient.restoreObject(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

取值范围:

长度为3~63个字符。

默认取值:

Key

string

必选

参数解释:

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

约束限制:

ObsClient.restoreObject中指定的对象必须是归档存储类别,否则调用该接口会报错。

取值范围:

长度大于0且不超过1024的字符串。

默认取值:

VersionId

string

可选

参数解释:

待恢复归档存储对象的版本号。

约束限制:

取值范围:

长度为32的字符串。

默认取值:

无,如果不设置则默认指定最新版本的对象。

Days

number

必选

参数解释:

恢复对象后,会生成一个对象的标准存储副本,此参数指定恢复有效期,即标准存储副本的保存时间。

约束限制:

取值范围:

[1, 30],单位:天。

默认取值:

Tier

RestoreTierType

可选

参数解释:

恢复选项,用户可根据需求选择恢复选项,不同的恢复选项恢复耗时不同。

约束限制:

取值范围:

恢复选项可选值详见RestoreTierType

默认取值:

Standard

表2 RestoreTierType

常量名

原始值

说明

ObsClient.enums.RestoreTierExpedited

Expedited

快速恢复,归档存储恢复耗时1~5 min。

ObsClient.enums.RestoreTierStandard

Standard

标准恢复,归档存储恢复耗时3~5 h。

返回结果

表3 返回结果

参数类型

描述

表4

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见表4

表4 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

表6

参数解释:

操作成功后的结果数据,详见表6

约束限制:

当Status大于300时为空。

表5 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表6 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

代码示例

您可以通过ObsClient.restoreObject恢复归档存储对象。以下代码展示了如何下载归档存储对象:

// 引入obs库
// 使用npm安装
const ObsClient = require("esdk-obs-nodejs");
// 使用源码安装
// var ObsClient = require('./lib/obs');
// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // security_token: process.env.SECURITY_TOKEN,
  // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例,其他地区请按实际情况填写
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function downloadColdObject() {
  // 指定存储桶名称
  const bucketName = "examplebucket";
  // 指定下载对象,此处以 example/objectname 为例
  const objectKey = "example/objectname";
  try {
     // 恢复归档存储对象
    const restoreObjectOutput = await obsClient.restoreObject({
      Bucket: bucketName,
      Key: objectKey,
      // 指定恢复对象的保存时间,此处以1为例,单位天,取值范围:[1, 30]
      Days: 1,
      // 指定恢复选项,此处以obs.RestoreTierExpedited为例,默认为快速恢复
      Tier: obs.enums.RestoreTierExpedited
    });
    if (restoreObjectOutput.CommonMsg.Status > 300) {
      handleMessage(restoreObjectOutput.CommonMsg);
      return;
    };
    // 等待对象恢复
    await sleep(5 * 60);
    // 下载对象
    const getObjectOutput = await obsClient.getObject({
      Bucket: bucketName,
      Key: objectKey,
    });
    if (getObjectOutput.CommonMsg.Status > 300) {
      handleMessage(getObjectOutput.CommonMsg);
      return;
    };
    console.log("Get object(%s) under the bucket(%s) successful!", params.Key, params.Bucket);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
    console.log('Object Content: %s', result.InterfaceResult.Content); 
  } 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);
  };
};

function handleMessage(commonMsg) {
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", commonMsg.Status);
    console.log("Code: %s", commonMsg.Code);
    console.log("Message: %s", commonMsg.Message);
    console.log("RequestId: %s", commonMsg.RequestId);
};

function sleep() {
    return new Promise(resolve => {
        setTimeout(resolve, time * 1000);
    });
} ;

downloadColdObject();