文档首页/ 对象存储服务 OBS/ SDK参考/ Node.js/ 对象相关接口(Node.js SDK)/ 基础操作(Node.js SDK)/ 下载对象(Node.js SDK)/ 获取下载进度(Node.js SDK)
更新时间：2026-04-28 GMT+08:00
查看PDF
分享

获取下载进度(Node.js SDK)

开发过程中，您有任何问题可以在GitHub上提交issue，或者在华为云对象存储服务论坛中发帖求助。

功能说明

获取下载对象进度是指在进行对象下载操作时，实时监控并获取下载进度的功能。通过实现进度监听接口，可以获取到下载任务的开始、数据传输中、下载完成或失败等状态信息，以及已下载字节数和总字节数。

接口约束

  • 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。
  • 当前只支持断点续传下载接口。

方法定义

fun ProgressCallback(transferredAmount, totalAmount, totalSeconds)

请求参数

表1 请求参数列表

参数名称

类型

说明

transferredAmount

int

参数解释：

已传输的字节数

totalAmount

int

参数解释：

需要传输的总字节数。

totalSeconds

int

参数解释：

传输已消耗的时间，单位是秒

返回结果

该进度回调函数无返回值

代码示例-断点续传下载接口

本示例用于断点下载examplebucket桶中的example/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
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
 
// 引入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/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.cn-north-4.myhuaweicloud.com",
});

async function downloadFile() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: 'examplebucket',
      // 指定对象名，此处以 example/objectname 为例
      Key: 'example/objectname',
      // 指定下载对象的本地文件全路径，此处以/tmp/objectname为例。当该值为空时，默认为当前程序的运行目录
      DownloadFile: 'localfile',
      // 指定是否开启断点续传模式，此处以true为例。默认为false，表示不开启
      EnableCheckpoint: true,
      // 指定分段大小，单位字节。此处以每段9M为例
      PartSize: 9 * 1024 * 1024,
      // 指定分段下载时的最大并发数，此处以并发数5为例
      TaskNum: 5,
      // 进度条回调
      ProgressCallback: function(transferredAmount, totalAmount, totalSeconds){
         // 获取上传平均速率（KB/S）
         console.log(transferredAmount * 1.0 / totalSeconds / 1024);
         // 获取上传进度百分比console
         console.log(transferredAmount * 100.0 / totalAmount);
      };
    };
    // 断点续传下载对象
    const result = await obsClient.downloadFile(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Download file(%s) under the bucket(%s) successful!", params.Key, params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log("StorageClass:%s, ETag:%s, ContentType:%s, ContentLength:%d, LastModified:%s",
        result.InterfaceResult.StorageClass, result.InterfaceResult.ETag, result.InterfaceResult.ContentType,
        result.InterfaceResult.ContentLength, result.InterfaceResult.LastModified,
      );
      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);
  };
};

downloadFile();

相关文档