OBS NODE.JS SDK-断点续传下载:请求参数

时间:2023-11-08 22:54:51

请求参数

字段名

类型

约束

说明

Bucket

String

必选

桶名。

Key

String

必选

对象名。

DownloadFile

String

可选

下载对象的本地文件全路径。当该值为空时,默认为当前程序的运行目录。

PartSize

Number

可选

分段大小,单位字节,取值范围是100KB~5GB,默认为5MB。

TaskNum

Number

可选

分段下载时的最大并发数,默认为20。

ProgressCallback

Function

可选

获取下载进度的回调函数。

说明:

该回调函数依次包含三个参数:已下载的字节数、总字节数、已使用的时间(单位:秒)。

ResumeCallback

Function

可选

获取取消断点续传控制参数的回调函数。

说明:
  • 该回调函数有一个参数:取消断点续传下载任务控制参数;
  • 可以调用取消断点续传下载任务控制参数的cancel方法来暂停断点续传下载任务。

EnableCheckpoint

Boolean

可选

是否开启断点续传模式,默认为false,表示不开启。

CheckpointFile

String

可选

记录下载进度的文件,只在断点续传模式下有效。当该值为空时,默认与下载对象的本地文件路径同目录。

VersionId

String

可选

对象的版本号。

IfModifiedSince

String

可选

如果对象的修改时间晚于该参数值指定的时间,则返回对象内容,否则返回异常码。

IfUnmodifiedSince

String

可选

如果对象的修改时间早于该参数值指定的时间,则返回对象内容,否则返回异常码。

IfMatch

String

可选

如果对象的ETag值与该参数值相同,则返回对象内容,否则返回异常码。

IfNoneMatch

String

可选

如果对象的ETag值与该参数值不相同,则返回对象内容,否则返回异常码。

SseC

String

可选

以SSE-C方式解密对象,支持的值:

  • AES256

SseCKey

String

可选

SSE-C方式下解密的密钥,由AES256算法算出。

support.huaweicloud.com/api-obs_nodejs_sdk_api_zh/obs_39_0504.html