文档首页/ 对象存储服务 OBS/ SDK参考/ Harmony(公测)/ 对象相关接口(HarmonyOS SDK)/ 基础操作/ 批量恢复归档或深度归档存储对象(HarmonyOS SDK)
更新时间:2026-08-28 GMT+08:00
分享

批量恢复归档或深度归档存储对象(HarmonyOS SDK)

功能说明

本示例用于批量恢复归档或深度归档存储的对象,使其临时转换为可读状态。通过对象列表指定需要恢复的对象,利用 Promise.all 分批并发执行 restoreObject 请求,可指定恢复速率(Tier)和保留天数(Days)。

接口约束

  • 您必须是桶拥有者或拥有恢复归档或深度归档存储对象的权限,才能恢复归档或深度归档存储对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:RestoreObject权限,如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 仅归档或深度归档存储的对象需要恢复才能访问,恢复请求提交后对象进入临时恢复状态,恢复完成后可读取。
  • Tier 指定恢复速率:Expedited(快速恢复)、Standard(标准恢复),不同速率的恢复时长与计费标准不同。
  • Days 指定恢复后对象的保留天数,取值范围为 1~30,超过保留天数后对象将自动转回归档状态。
  • 对已处于恢复状态的对象重复调用 restoreObject 不会叠加保留期,保留期以最近一次成功恢复请求的 Days 为准。
  • 并发数不宜过大,避免占用过多内存与带宽,建议根据设备性能和网络情况设置。

方法定义

本接口为组合调用示例,基于 restoreObject 接口实现批量恢复。

1
restoreObject(input: RestoreObjectInput): Response<BaseResponseOutput>

请求参数

本接口为组合调用示例,基于 restoreObject 接口实现批量操作,请求参数与 restoreObject 接口一致,详细参数说明请参见RestoreObjectInput参数表。

代码示例

本示例用于批量恢复 examplebucket 桶内的归档对象,恢复速率设置为 Standard(标准恢复),保留天数设置为 7 天,并发数设置为 3。

 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// 引入依赖包
import ObsClient, { RestoreObjectInput, RestoreTierType } from '@obs/esdk-obs-harmony';
import { process } from '@kit.ArkTS';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const processManager = new process.ProcessManager();

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"),
  SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"),
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"),
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

// 需要恢复的归档对象Key列表
const archiveObjectKeys: string[] = [
  "archive-object1.txt",
  "archive-object2.txt",
  "archive-object3.txt",
  "archive-object4.txt",
  "archive-object5.txt",
];

interface RestoreResult {
  key: string;
  success: boolean;
  error?: string;
}

async function batchRestore() {
  const bucket = "examplebucket";
  const days = 7;
  const tier = RestoreTierType.STANDARD;
  const concurrentCount = 3;
  const results: RestoreResult[] = [];

  for (let i = 0; i < archiveObjectKeys.length; i += concurrentCount) {
    const batch = archiveObjectKeys.slice(i, i + concurrentCount);
    const batchResults = await Promise.all(
      batch.map(async (objectKey) => {
        try {
          const params: RestoreObjectInput = {
            Bucket: bucket,
            Key: objectKey,
            Days: days,
            Tier: tier,
          };
          const result = await obsClient.restoreObject(params);
          if (result.CommonMsg.Status < 300) {
            hilog.info(0x0001, 'OBS-Harmony', "Restore request submitted: %s, Status: %d", objectKey, result.CommonMsg.Status);
            return { key: objectKey, success: true } as RestoreResult;
          } else {
            hilog.error(0x0001, 'OBS-Harmony', "Restore failed: %s, Status: %d, Code: %s", objectKey, result.CommonMsg.Status, result.CommonMsg.Code);
            return { key: objectKey, success: false, error: result.CommonMsg.Message } as RestoreResult;
          }
        } catch (error) {
          const err = error as BusinessError;
          hilog.error(0x0001, 'OBS-Harmony', 'Restore exception: %s, code=%d, message: %s', objectKey, err.code, err.message);
          return { key: objectKey, success: false, error: err.message } as RestoreResult;
        }
      })
    );
    results.push(...batchResults);
  }

  const successCount = results.filter(r => r.success).length;
  const failedCount = results.length - successCount;
  hilog.info(0x0001, 'OBS-Harmony', "Batch restore complete: %d/%d success, %d failed", successCount, results.length, failedCount);
}

batchRestore();
      

相关链接

  • 关于批量恢复所调用的恢复归档存储对象的API说明,请参见恢复归档存储对象
  • 恢复对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档