# 断点续传下载(HarmonyOS SDK) #### 功能说明 断点续传下载基于 Range 分段下载实现，适用于大文件下载场景。SDK 按分段大小并发下载各段到临时文件，下载完成后将临时文件原子重命名为目标文件。开启断点续传后，下载中断可依据检查点续传未完成段。 #### 接口约束 - 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` downloadFile(input: DownloadFileInput): Response ``` #### 请求参数 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [DownloadFileInput] | 必选 | **参数解释：** 断点续传下载接口入参，详见[DownloadFileInput]。 | 表2DownloadFileInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值：** 无 | | Key | string | 必选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | VersionId | string | 可选 | **参数解释：** 对象的版本号，用于获取指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 **取值范围：** 长度为32的字符串。 **默认取值：** 无，如果不设置则默认获取最新版本的对象。 | | DownloadFile | string | 可选 | **参数解释：** 本地目标下载路径。 **默认取值：** 无。 | | PartSize | number | 可选 | **参数解释：** 分段大小，单位字节。 **取值范围：** 最小100KB，最大5GB。 **默认取值：** 9MB（9437184）。段数超10000时按文件大小/10000自动重算。 | | TaskNum | number | 可选 | **参数解释：** 并发下载段数。 **默认取值：** 1。调大可加快下载但占用更多内存与带宽。 | | EnableCheckpoint | boolean | 可选 | **参数解释：** 是否开启断点续传落盘。 **默认取值：** false。开启后下载中断可依据检查点续传。 | | CheckpointFile | string | 可选 | **参数解释：** 检查点文件路径，EnableCheckpoint为true时必填。 **默认取值：** 无。 | | ProgressCallback | ProgressCallback | 可选 | **参数解释：** 下载进度回调，按已下载字节数回调。 **默认取值：** 无。 | | SseC | string | 作为请求参数时必选 | **参数解释：** 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 **取值范围：** 可选值：AES256，即选择SSE-C方式加密对象。 **默认取值：** 无 | | SseCKey | string | 作为请求参数时必选 | **参数解释：** SSE-C方式下加密使用的密钥，该密钥用于加密对象。 **约束限制：** 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=。 **默认取值：** 无 | | IfMatch | string | 可选 | **参数解释：** 指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | IfNoneMatch | string | 可选 | **参数解释：** 指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | IfModifiedSince | string | 可选 | **参数解释：** 如果对象在指定的时间后有修改，则返回对象内容，否则返回错误。 **约束限制：** 日期格式必须为ISO8601的格式。 例如：2018-01-01T00:00:00.000Z，表示如果最后修改时间晚于2018-01-01T00:00:00.000Z则返回对象内容，否则返回错误。 代码示例：*new Date(Date.now() - 24 \* 60 \* 60 \* 1000)*。 **默认取值：** 无 | | IfUnmodifiedSince | string | 可选 | **参数解释：** 如果对象在指定的时间后没有修改，则返回对象内容，否则返回错误。 **约束限制：** 日期格式必须为ISO8601的格式。 例如：2018-01-01T00:00:00.000Z，表示如果最后修改时间早于2018-01-01T00:00:00.000Z则返回对象内容，否则返回错误。 代码示例：*new Date(Date.now() - 24 \* 60 \* 60 \* 1000)*。 **默认取值：** 无 | ![](https://support.huaweicloud.com/sdk-harmony-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。 - 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。 #### 返回结果 表3返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明： 该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表4Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [GetObjectOutput] | **参数解释：** 操作成功后的结果数据，详见[GetObjectOutput]。 **约束限制：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6GetObjectMetadataOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | StorageClass | [StorageClassType] | **参数解释：** 下载时返回对象的存储类型。如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。 **取值范围：** 可选择的存储类型参见[StorageClassType]。 **默认取值：** 无 | | AllowOrigin | string | **参数解释：** 如果请求中的Origin满足桶的CORS规则，则返回CORS规则中的AllowedOrigin。AllowedOrigin指定允许的跨域请求的来源，即允许来自该域名下的请求访问该对象。 **约束限制：** 表示域名的字符串，每个匹配规则允许使用最多一个"\*"通配符。例如：https://\*.obs.example.com。 **默认取值：** 无 | | AllowHeader | string | **参数解释：** 如果请求的RequestHeader满足桶的CORS规则，则返回CORS规则中的AllowedHeader。AllowedHeader是指允许的跨域请求的头域。只有匹配上允许的头域中的配置，才被视为是合法的CORS请求。 **约束限制：** 最多可填写一个"\*"通配符，不支持\&、:、\<、空格以及中文字符。 **默认取值：** 无 | | AllowMethod | string | **参数解释：** 桶CORS规则中的AllowedMethod。AllowedMethod指允许的跨域请求HTTP方法，即桶和对象的几种操作类型。 **取值范围：** 支持以下HTTP方法： - GET - PUT - HEAD - POST - DELETE **默认取值：** 无 | | ExposeHeader | string | **参数解释：** 桶CORS规则中的ExposeHeader。ExposeHeader是指CORS规则允许响应中可返回的附加头域，给客户端提供额外的信息。默认情况下浏览器只能访问以下头域：Content-Length、Content-Type，如果需要访问其他头域，需要在附加头域中配置。 **约束限制：** 不支持\*、\&、:、\<、空格以及中文字符。 **默认取值：** 无 | | MaxAgeSeconds | number | **参数解释：** 桶CORS规则中的MaxAgeSeconds。MaxAgeSeconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。 **约束限制：** 每个CORSRule可以包含至多一个MaxAgeSeconds。 **取值范围：** 0\~（2^31^-1），单位：秒。 **默认取值：** 100，单位：秒。 | | ContentLength | number | **参数解释：** 对象数据的长度。 **取值范围：** 0\~（2^63^-1），单位：字节。 **默认取值：** 无 | | ContentType | string | **参数解释：** 对象的文件类型（MIME类型）。Content-Type（MIME）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。 **取值范围：** 常见的Content-Type（MIME）列表请参见[如何理解Content-Type（MIME）](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0604.html)。 **默认取值：** 如果您在上传Object时未指定Content-Type，SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。 | | LastModified | string | **参数解释：** 对象的最近一次修改时间。 **约束限制：** 日期格式必须为ISO8601的格式。 例如：2018-01-01T00:00:00.000Z，表示最后一次修改时间为2018-01-01T00:00:00.000Z。 **默认取值：** 无 | | ETag | string | **参数解释：** 对象的ETag值。对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 **约束限制：** 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | VersionId | string | **参数解释：** 对象的版本号。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | Restore | string | **参数解释：** 标识对象的恢复状态。对象为归档存储或深度归档存储类型，并且处于正在恢复或已经恢复时，会返回此头域。 示例：正在恢复ongoing-request="true"；已恢复 ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT"。其中expiry-date表示对象恢复后的失效时间。 **约束限制：** 归档存储类型对象的恢复状态，如果对象不为归档存储类型，则该值为空。 **默认取值：** 无 | | Expiration | string | **参数解释：** 对象的详细过期信息。比如："expiry-date=\\"Mon, 11 Sep 2023 00:00:00 GMT\\""。 **默认取值：** 无 | | WebsiteRedirectLocation | string | **参数解释：** 当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据"WebsiteRedirectLocation"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 **默认取值：** 无 | | Metadata | object | **参数解释：** 对象的自定义元数据。OBS支持用户使用以"x-obs-meta-"开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 **约束限制：** - 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。 - 自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。 - 自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经URL编码后发送，"中文"的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87。 **默认取值：** 无 | 表7StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。 适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 代码示例 本示例将 examplebucket 桶的 objectname 对象断点续传下载到本地文件。 ``` // 引入依赖包 import ObsClient, { DownloadFileInput } 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", }); async function downloadFile() { try { const params: DownloadFileInput = { Bucket: "examplebucket", Key: "objectname", DownloadFile: "/path/to/local.txt", PartSize: 9 * 1024 * 1024, TaskNum: 5, EnableCheckpoint: true, CheckpointFile: "/path/to/download.cp", ProgressCallback: (transferred, total, seconds) => { hilog.info(0x0001, 'OBS-Harmony', "downloaded %d / %d bytes (%ds)", transferred, total, seconds); }, }; const result = await obsClient.downloadFile(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "DownloadFile(%s) under the bucket(%s) successful!", params.Key, params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response.") hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { hilog.info(0x0001, 'OBS-Harmony', "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.") hilog.info(0x0001, 'OBS-Harmony', error); } } downloadFile(); ``` #### 相关链接 - 关于下载对象的API说明，请参见[获取对象内容](https://support.huaweicloud.com/api-obs/obs_04_0083.html)。 - 下载对象过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 下载对象常见问题请参见[下载对象失败](https://support.huaweicloud.com/obs_faq/obs_faq_0135.html)。