Node.js SDK开发指南

Size: px

Start display at page:

Download "Node.js SDK开发指南"

牲游
4 years ago
Views:

1 文档版本 07 发布日期华为技术有限公司

2 版权所有华为技术有限公司 2019 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品服务或特性可能不在您的购买或使用范围之内除非合同另有约定, 华为公司对本文档内容不做任何明示或默示的声明或保证由于产品版本升级或其他原因, 本文档内容会不定期进行更新除非另有约定, 本文档仅作为使用指导, 本文档中的所有陈述信息和建议不构成任何明示或暗示的担保文档版本 07 ( ) 版权所有华为技术有限公司 i

3 目录目录 1 相关资源 SDK 下载示例程序技术支持渠道快速入门使用前需知 OBS 服务环境搭建开发环境准备安装 SDK 获取服务地址初始化 OBS 客户端创建桶上传对象下载对象列举对象删除对象 OBS 客户端通用示例预定义常量初始化配置密钥创建 OBS 客户端配置 OBS 客户端配置 SDK 日志配置 SDK 验证服务端证书管理桶创建桶列举桶删除桶判断桶是否存在获取桶元数据管理桶访问权限管理桶策略文档版本 07 ( ) 版权所有华为技术有限公司 ii

4 目录 4.8 获取桶区域位置获取桶存量信息桶配额桶存储类型上传对象对象上传简介文本上传流式上传文件上传创建文件夹设置对象属性分段上传设置对象生命周期追加上传分段复制断点续传上传基于表单上传下载对象对象下载简介文本下载流式下载文件下载范围下载限定条件下载重写响应头获取自定义元数据下载归档存储对象断点续传下载图片处理管理对象获取对象属性管理对象访问权限列举对象删除对象复制对象授权访问使用 URL 进行授权访问多版本控制多版本控制简介设置桶多版本状态文档版本 07 ( ) 版权所有华为技术有限公司 iii

5 目录 9.3 查看桶多版本状态获取多版本对象复制多版本对象取回多版本归档存储对象列举多版本对象多版本对象权限删除多版本对象生命周期管理生命周期管理简介设置生命周期规则查看生命周期规则删除生命周期规则跨域资源共享跨域资源共享简介设置跨域规则查看跨域规则删除跨域规则设置访问日志日志简介开启桶日志查看桶日志配置关闭桶日志静态网站托管静态网站托管简介网站文件托管设置托管配置查看托管配置清除托管配置标签管理标签简介设置桶标签查看桶标签删除桶标签事件通知事件通知简介设置事件通知查看事件通知关闭事件通知服务端加密服务端加密简介文档版本 07 ( ) 版权所有华为技术有限公司 iv

6 目录 16.2 加密加密示例异常处理 OBS 服务端错误码 SDK 公共结果对象日志分析缺少模块异常连接超时异常签名不匹配异常常见问题如何进行分段上传如何创建文件夹如何列出所有对象如何使用 URL 进行授权访问如何使用表单上传如何分段下载大对象如何验证服务端根证书如何使对象可以被匿名用户访问如何确定 OBS 服务地址和区域信息如何获取访问密钥如何使用 npm 下载 SDK A API 参考 B 修订记录文档版本 07 ( ) 版权所有华为技术有限公司 v

7 1 相关资源 1 相关资源 1.1 SDK 下载下载地址 OBS Node.js SDK 最新版本 :OBS Node.js SDK OBS Node.js SDK 历史版本下载 : OBS Node.js SDK OBS Node.js SDK OBS Node.js SDK OBS Node.js SDK OBS Node.js SDK SDK 源码和 API 文档 SDK 源码请参见 :GitHub 接口参考文档地址 :SDK API 文档兼容性版本修订记录信息 :ChangeLog 推荐使用的 Node.js 版本 :Node 0.12.x,Node4.x,Node6.x,Node8.x,Node10.x 接口函数 : 与旧版本 (2.1.x) 不完全兼容, 接口变化如下表 : 接口函数 ObsClient.listBuckets ObsClient.setBucketAcl ObsClient.getBucketAcl 变化响应结果中 InterfaceResult.Buckets 字段变为数组, 去掉 InterfaceResult.Buckets.Bucket 字段请求参数中 Grants 字段变为数组, 去掉 Grants.Grant 字段响应结果中 InterfaceResult.Grants 字段变为数组, 去掉 InterfaceResult.Grants.Grant 字段文档版本 07 ( ) 版权所有华为技术有限公司 1

8 1 相关资源接口函数 ObsClient.setObjectAcl ObsClient.getObjectAcl ObsClient.setBucketLog ging ObsClient.getBucketLog ging ObsClient.setBucketWeb site ObsClient.getBucketWe bsite ObsClient.setBucketCor s ObsClient.getBucketCor s ObsClient.setBucketTag ging ObsClient.getBucketTag ging 变化请求参数中 Grants 字段变为数组, 去掉 Grants.Grant 字段响应结果中 InterfaceResult.Grants 字段变为数组, 去掉 InterfaceResult.Grants.Grant 字段请求参数中 LoggingEnabled.TargetGrants 字段变为数组, 去掉 LoggingEnabled.TargetGrants.Grant 字段响应结果中 InterfaceResult.LoggingEnabled.TargetGrants 字段变为数组, 去掉 InterfaceResult.LoggingEnabled.TargetGrants.Grant 字段请求参数中 RoutingRules 字段变为数组, 去掉 RoutingRules.RoutingRule 字段响应结果中 InterfaceResult.RoutingRules 字段变为数组, 去掉 InterfaceResult.RoutingRules.RoutingRule 字段请求参数中 CorsRule 字段改名为 CorsRules 响应结果中 InterfaceResult.CorsRule 字段改名为 InterfaceResult.CorsRules 请求参数中 TagSet 字段改名为 Tags 并变为数组, 去掉 TagSet.Tag 字段响应结果中 InterfaceResult.TagSet 字段改名为 Tags 并变为数组, 去掉 InterfaceResult.TagSet.Tag 字段 1.2 示例程序 OBS Node.js SDK 提供了丰富的示例程序, 方便用户参考或直接使用您可以从 OBS Node.js SDK 开发包中获取示例程序, 如 esdk_storage_obs_<versionid>_node.js.zip, 解压后 esdk_storage_obs_<versionid>_node.js/examples 为示例程序您也可以从下面表格中直接下载示例程序示例包括以下内容 : 示例代码 bucket-operations-sample object-operations-sample download-sample create-folder-sample 展示了桶相关接口的用法展示了对象相关接口的用法展示了下载对象的用法展示了创建文件夹的用法文档版本 07 ( ) 版权所有华为技术有限公司 2

9 1 相关资源示例代码 delete-objects-sample list-objects-sample list-versions-sample list-objects-infolder-sample object-meta-sample simple-multipart-upload-sample restore-object-sample concurrent-copypart-sample concurrent-download-object-sample concurrent-uploadpart-sample post-object-sample temporary-signature-sample 展示了批量删除对象的用法展示了列举对象的用法展示了列举多版本对象的用法展示了列举文件夹内对象的用法展示了自定义对象元数据的用法展示了分段上传的基本用法展示了下载归档存储对象的用法展示了分段并发复制大对象的用法展示了分段并发下载大对象的用法展示了分段并发上传大对象的用法展示了表单上传对象的用法展示了使用 URL 进行授权访问的用法 1.3 技术支持渠道开发者社区提供的技术支持渠道如下 : 开发过程中, 您有任何问题可以在华为云论坛中发帖求助文档版本 07 ( ) 版权所有华为技术有限公司 3

10 2 快速入门 2 快速入门 2.1 使用前需知请确认您已经熟悉 OBS 的基本概念, 如桶 (Bucket) 对象 (Object) 访问密钥 (AK 和 SK) 等您可以先参考 OBS 客户端通用示例, 了解 OBS Node.js SDK 接口调用的通用方式 OBS 客户端支持回调函数和 Promise 对象两种方式返回调用结果 2.2 OBS 服务环境搭建步骤 1 注册云服务账号使用 OBS 之前必须要有一个云服务账号 1. 打开浏览器 2. 登录公有云网站 3. 在页面右上角单击注册 4. 按需填写注册信息并单击同意协议并注册步骤 2 开通 OBS 服务使用 OBS 服务之前必须先充值, 才能正常使用 OBS 服务 1. 登录 OBS 管理控制台 2. 单击页面右上角的用户名并选择用户中心进入用户中心页面 3. 单击充值, 系统自动跳转到充值窗口 4. 根据界面提示信息, 对账户进行充值 5. 充值成功后, 关闭充值窗口, 返回管理控制台首页 6. 单击, 开通并进入 OBS 管理控制台步骤 3 创建访问密钥 OBS 通过用户账户中的 AK 和 SK 进行签名验证, 确保通过授权的账户才能访问指定的 OBS 资源以下是对 AK 和 SK 的解释 : 文档版本 07 ( ) 版权所有华为技术有限公司 4

11 2 快速入门 AK:Access Key ID, 接入键标识, 用户在系统中的接入键标识, 一个接入键标识唯一对应一个用户, 一个用户可以同时拥有多个接入键标识系统通过接入键标识识别访问系统的用户 SK:Secret Access Key, 安全接入键, 用户在系统中的安全接入键, 是用户访问系统的密钥, 用户根据安全接入键和请求头域生成鉴权信息安全接入键和接入键标识一一对应创建访问密钥的操作步骤如下 : 1. 登录 OBS 控制台 2. 单击页面右上角的用户名, 并选择我的凭证 3. 进入我的凭证页面, 单击管理访问密钥页签下方的新增访问密钥 4. 在弹出的新增访问密钥对话框中, 输入登录密码和对应验证码用户如果未绑定邮箱和手机, 则只需输入登录密码用户如果同时绑定了邮箱和手机, 可以选择其中一种方式进行验证 5. 单击确定 6. 在弹出的下载确认提示框中, 单击确定后, 密钥会直接保存到浏览器默认的下载文件夹中 7. 打开下载下来的 credentials.csv 文件既可获取到访问密钥 (AK 和 SK) ---- 结束每个用户最多可创建两个有效的访问密钥为防止访问密钥泄露, 建议您将其保存到安全的位置如果用户在此提示框中单击取消, 则不会下载密钥, 后续也将无法重新下载如果需要使用访问密钥, 可以重新创建新的访问密钥 2.3 开发环境准备从 Node.js 官网下载并安装推荐使用的版本从 Eclipse 官网下载并安装 Eclipse IDE for JavaScript and Web Developer 最新版本 2.4 安装 SDK 使用 npm 安装 ( 推荐 ) 步骤 1 步骤 2 运行 npm -v 命令查看 npm 版本并确保 npm 已安装运行 npm install esdk-obs-nodejs 命令执行安装 ---- 结束文档版本 07 ( ) 版权所有华为技术有限公司 5

12 2 快速入门如果您使用的是 Windows 操作系统, 当运行 npm 命令时提示不是内部或外部命令, 请在 Path 环境变量中增加 npm 的安装目录 ( 一般为 Node.js 的安装目录 ) 您可能需要重启电脑使环境变量生效如果您使用 npm 安装依赖时出现网络错误, 请使用代理使用源码安装以安装 OBS Node.js SDK 最新版本为例, 步骤如下 : 步骤 1 步骤 2 步骤 3 步骤 4 下载 OBS Node.js SDK 开发包解压该开发包, 可以看到其中包含 examples 文件夹 ( 示例代码 ),lib 文件夹 (SDK 源码 ),package.json 文件 ( 依赖配置文件 ) 和 README.txt(SDK 版本特性描述文件 ) 命令行切换到 SDK 开发包解压目录, 运行 npm install 安装依赖库, 生成 node_modules 文件夹 ( 可选 ) 在 Eclipse JavaScript 项目中导入源码打开 Eclipse JavaScript IDE, 选择 Import > Projects from Folder or Archive, 并在 Import source 中选择 SDK 开发包解压目录 ---- 结束安装完成后, 您的目录结构应该像下面这样 : examples lib node_modules package.json README.txt 2.5 获取服务地址您可以从这里查看 OBS 当前开通的服务地址和区域信息 SDK 支持带协议名和不带协议名两种方式传入服务地址, 例如获取到的服务地址为 your-endpoint, 则初始化 OBS 客户端时传入的服务地址可以为和 your-endpoint 三种形式 2.6 初始化 OBS 客户端向 OBS 发送任一 HTTP/HTTPS 请求之前, 必须先创建一个 ObsClient 实例 : 文档版本 07 ( ) 版权所有华为技术有限公司 6

13 2 快速入门 // 使用访问 OBS // 关闭 obsclient obsclient.close(); 更多关于 OBS 客户端初始化的内容请参考初始化章节 2.7 创建桶桶是 OBS 全局命名空间, 相当于数据的容器文件系统的根目录, 可以存储若干对象以下代码展示如何新建一个桶 : obsclient.createbucket({ console.error('error-->' + err); 桶的名字是全局唯一的, 所以您需要确保不与已有的桶名称重复桶命名规则如下 : 3~63 个字符, 数字或字母开头, 支持小写字母数字 -. 禁止使用类 IP 地址禁止以 - 或. 开头及结尾禁止两个. 相邻 ( 如 : my..bucket ) 禁止. 和 - 相邻 ( 如 : my-.bucket 和 my.-bucket ) 同一用户多次创建同名桶不会报错, 创建的桶属性以第一次请求为准更多创建桶的信息, 请参见创建桶创建桶时, 如果使用的终端节点归属于默认区域华北 - 北京一 (cn-north-1), 则可以不指定区域 ; 如果使用的终端节点归属于其他区域, 则必须指定区域, 且指定的区域必须与终端节点归属的区域一致当前有效的区域名称有 :cn-north-1 cneast-2 cn-south-1 ap-southeast-1 您可以使用带参数创建方式, 在创建桶时, 指定桶的区域位置 2.8 上传对象以下代码展示如何上传对象至 OBS: obsclient.putobject({ 文档版本 07 ( ) 版权所有华为技术有限公司 7

14 2 快速入门 Key : 'objectname', Body : 'Hello OBS' console.error('error-->' + err); 更多上传对象的信息, 请参见上传对象 2.9 下载对象以下代码展示如何获取对象的内容 : obsclient.getobject({ Key : 'objectname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log(result.interfaceresult.content.tostring()); 更多下载对象的信息, 请参见下载对象 2.10 列举对象当完成一系列上传对象操作后, 可能需要查看桶中包含哪些对象以下代码展示如何列举指定桶中的对象 : obsclient.listobjects({ Bucket : 'bucketname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ for(let i=0;i<result.interfaceresult.contents.length;i++){ console.log('contents[' + j + ']:'); console.log('key-->' + result.interfaceresult.contents[j]['key']); console.log('lastmodified-->' + result.interfaceresult.contents[j] ['LastModified']); console.log('size-->' + result.interfaceresult.contents[j]['size']); 上面的代码默认列举 1000 个对象 (Object) 更丰富的列举功能, 请参见列举对象文档版本 07 ( ) 版权所有华为技术有限公司 8

15 2 快速入门 2.11 删除对象以下代码展示如何删除指定的对象 : obsclient.deleteobject({ Key : 'objectname' console.error('error-->' + err); 2.12 OBS 客户端通用示例回调函数返回结果 : OBS 客户端可通过回调函数的形式返回结果, 回调函数依次包含异常信息和 SDK 公共结果对象两个参数如果回调函数中异常信息参数不为空, 则表明接口调用异常 ; 反之, 则表明接口调用完成, 此时应从 SDK 公共结果对象中获取 HTTP 状态码, 判断操作是否成功示例代码如下 : // 构造桶操作请求参数 var requestparam1 = { Bucket : 'bucketname' // 其他字段 ; var callback1 = (err, result) => { // 处理桶操作调用结果 ; // 调用桶操作接口, 如创建桶 obsclient.createbucket(requestparam1, callback1); // 构造对象操作请求参数 var requestparam2 = { Key : 'objectname' // 其他字段 ; var callback2 = (err, result) => { // 处理对象操作调用结果 ; // 调用对象操作接口, 如下载对象 obsclient.getobject(requestparam2, callback2); 文档版本 07 ( ) 版权所有华为技术有限公司 9

16 2 快速入门对于桶操作接口, 请求对象中固定包含 Bucket 字段用于指定桶名 ; 对于对象操作接口, 请求对象中固定包含 Bucket 字段和 Key 字段分别用于指定桶名与对象名以下代码展示了使用回调函数返回调用结果的通用示例 : // 调用接口进行操作, 例如上传对象 obsclient.putobject({ Key : 'objectname', Body : 'Hello OBS' // 异常信息不为空, 表明接口调用异常 console.log('error-->' + err); // 异常信息为空, 表明接口调用完成, 应进一步判断 HTTP 状态码 if(result.commonmsg.status < 300){// 操作成功 if(result.interfaceresult){ // 处理操作成功后业务逻辑 // 操作失败, 获取详细异常信息 console.log('code-->' + result.commonmsg.code); console.log('message-->' + result.commonmsg.message); console.log('hostid-->' + result.commonmsg.hostid); console.log('requestid-->' + result.commonmsg.requestid); Promise 对象返回结果 : OBS 客户端可通过 Promise 对象返回结果, 如果通过 Promise 对象的 catch 方法没有捕获到异常, 则表明接口调用完成, 此时应从 SDK 公共结果对象中获取 HTTP 状态码, 判断操作是否成功示例代码如下 : // 构造桶操作请求参数 var requestparam1 = { Bucket : 'bucketname' // 其他字段 ; 文档版本 07 ( ) 版权所有华为技术有限公司 10

17 2 快速入门 // 调用桶操作接口, 如创建桶 var promise1 = obsclient.createbucket(requestparam1); promise1.then((result) => { // 处理桶操作调用结果 ).catch((err)=>{ // 处理错误 // 构造对象操作请求参数 var requestparam2 = { Key : 'objectname' // 其他字段 ; // 调用对象操作接口, 如下载对象 var promise2 = obsclient.getobject(requestparam2, callback2); promise2.then((result) => { // 处理对象操作调用结果 ).catch((err)=>{ // 处理错误对于桶操作接口, 请求对象中固定包含 Bucket 字段用于指定桶名 ; 对于对象操作接口, 请求对象中固定包含 Bucket 字段和 Key 字段分别用于指定桶名与对象名以下代码展示了使用 Promise 对象返回调用结果的通用示例 : // 调用接口进行操作, 例如上传对象 obsclient.putobject({ Key : 'objectname', Body : 'Hello OBS' ).then((result) => { // 接口调用完成, 应进一步判断 HTTP 状态码 if(result.commonmsg.status < 300){// 操作成功 if(result.interfaceresult){ // 处理操作成功后业务逻辑 // 操作失败, 获取详细异常信息 console.log('code-->' + result.commonmsg.code); console.log('message-->' + result.commonmsg.message); console.log('hostid-->' + result.commonmsg.hostid); console.log('requestid-->' + result.commonmsg.requestid); ).catch((err) => { // 接口调用发生异常 console.error('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 11

19 3 初始化 3 初始化 3.1 配置密钥要接入 OBS 服务, 您需要拥有一组有效的访问密钥 (AK 和 SK) 用来进行签名认证具体可参考 OBS 服务环境搭建获取 AK 和 SK 之后, 您便可以按照以下步骤进行初始化 3.2 创建 OBS 客户端通过构造函数创建 OBS 客户端 (ObsClient) 是访问 OBS 服务的 Node.js 客户端, 它为调用者提供一系列与 OBS 服务进行交互的接口, 用于管理操作桶 (Bucket) 和对象 (Object) 等 OBS 服务上的资源使用 OBS Node.js SDK 发起 OBS 请求, 您需要初始化一个 ObsClient 实例, 并根据需要修改客户端初始化配置参数 // 通过构造函数创建 ObsClient 实例 // 使用访问 OBS // 关闭 obsclient obsclient.close(); 通过工厂方法创建文档版本 07 ( ) 版权所有华为技术有限公司 13

20 3 初始化 // 通过工厂方法初始化 ObsClient 实例 var obsclient = new ObsClient(); obsclient.factory({ // 使用访问 OBS // 关闭 obsclient obsclient.close(); 您的工程中可以有多个 ObsClient, 也可以只有一个 ObsClient ObsClient 在调用 ObsClient.close 方法关闭后不能再次使用 3.3 配置 OBS 客户端您可通过初始化参数对 ObsClient 进行配置, 可以配置的参数见下表 : 参数描述建议值 access_key_id 访问密钥中的 AK N/A secret_access_key 访问密钥中的 SK N/A server max_retry_count 连接 OBS 的服务地址可包含协议类型域名端口号示例 : your-endpoint:443 HTTP/HTTPS 连接异常时的请求重试次数默认为 3 次 N/A [1,5] timeout HTTP/HTTPS 请求超时时间 ( 单位 : 秒 ) 默认为 60 秒 ssl_verify 验证服务端证书参数可能的取值 : 服务端 pem 格式根证书文件路径 ; true: 使用默认的 CAs 验证服务端证书 ; false: 表示不验证服务端证书默认为 false [10, 60] N/A long_conn_param is_cname 长连接模式参数 ( 单位 : 秒 ) 当该参数大于等于 0 时, 开启长连接模式, 并将该参数作为 TCP Keep-Alive 数据包的初始延迟默认为空, 代表关闭长连接模式是否通过自定义域名访问 OBS 服务默认为 false N/A N/A 文档版本 07 ( ) 版权所有华为技术有限公司 14

21 3 初始化建议值为 N/A 的表示需要根据实际情况进行设置如网络状况不佳, 建议增大 timeout 的值如果设置的 server 不带协议类型, 则默认使用 HTTPS 协议如果启用了长连接模式, 使用完 OBS 客户端后必须调用 ObsClient.close 方法显式关闭, 回收连接资源出于 DNS 解析性能和 OBS 服务可靠性的考虑, 不允许将 server 设置为 IP, 必须使用域名访问 OBS 服务 3.4 配置 SDK 日志 OBS Node.js SDK 基于 log4js 开源库提供了日志功能, 您可以通过 ObsClient.initLog 开启日志功能并进行配置示例代码如下 : obsclient.initlog({ file_full_path:'./logs/obs-sdk.log', // 配置日志文件路径 max_log_size:20480, // 配置日志文件大小, 单位 : 字节 backups:10, // 配置最大可保留的日志文件个数 level:'warn', // 配置日志级别 log_to_console:true // 配置是否将日志打印到 console 日志功能默认是关闭的, 需要主动开启您可以从日志分析章节获取更多关于 SDK 日志的信息 3.5 配置 SDK 验证服务端证书 OBS Node.js SDK 提供了对服务端证书验证的支持, 以确保 OBS 服务来自于受信服务端配置验证服务端证书的步骤如下 : 步骤 1 步骤 2 获取 OBS 服务端的根证书 ( 例如从 IE 浏览器的 Internet 属性 > 内容 > 证书中导出 ), 并保存为文件 obs.cer 运行命令 openssl x509 -inform der -in obs.cer -out obs.pem 将 cer 文件转换为 pem 文件步骤 3 修改 OBS 客户端配置代码, 开启服务端证书验证, 示例代码如下 :,// 配置使用 HTTPS 协议 ssl_verify : 'your_cafile_dir/obs.pem' // 配置 pem 格式根证书文件路径 ---- 结束文档版本 07 ( ) 版权所有华为技术有限公司 15

23 4 管理桶桶的名字是全局唯一的, 所以您需要确保不与已有的桶名称重复桶命名规则如下 : 3~63 个字符, 数字或字母开头, 支持小写字母数字 -. 禁止使用类 IP 地址禁止以 - 或. 开头及结尾禁止两个. 相邻 ( 如 : my..bucket ) 禁止. 和 - 相邻 ( 如 : my-.bucket 和 my.-bucket ) 同一用户在同一个区域多次创建同名桶不会报错, 创建的桶属性以第一次请求为准本示例创建的桶的访问权限默认是私有读写, 存储类型默认是标准类型, 区域位置是全局域名所在的默认区域创建桶时, 如果使用的终端节点归属于默认区域华北 - 北京一 (cn-north-1), 则可以不指定区域 ; 如果使用的终端节点归属于其他区域, 则必须指定区域, 且指定的区域必须与终端节点归属的区域一致当前有效的区域名称有 :cn-north-1 cneast-2 cn-south-1 ap-southeast-1 您可以使用带参数创建方式, 在创建桶时, 指定桶的区域位置带参数创建创建桶时可以指定桶的访问权限存储类型和区域位置 OBS 支持的桶的存储类型有三类, 参见桶存储类型示例代码如下 : // 创建桶 obsclient.createbucket({ // 设置桶访问权限为公共读, 默认是私有读写 ACL : obsclient.enums.aclpublicread, // 设置桶的存储类型为归档存储类型 StorageClass : obsclient.enums.storageclasscold, // 设置桶区域位置 Location : 'bucketlocation' console.error('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 17

24 4 管理桶使用 ACL 参数指定桶的访问权限 ; 使用 StorageClass 参数指定桶的存储类型 ; 使用 Location 参数指定桶的区域位置 4.2 列举桶您可以通过 ObsClient.listBuckets 列举桶以下代码展示如何获取桶列表 : // 列举桶 obsclient.listbuckets({ QueryLocation : true console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('requestid-->' + result.interfaceresult.requestid); console.log('owner:'); console.log('id-->' + result.interfaceresult.owner.id); console.log('name-->' + result.interfaceresult.owner.name); console.log('buckets:'); for(let i=0;i<result.interfaceresult.buckets.length;i++){ console.log('bucket[' + i + ']:'); console.log('bucketname-->' + result.interfaceresult.buckets[i].bucketname); console.log('creationdate-->' + result.interfaceresult.buckets[i].creationdate); console.log('location-->' + result.interfaceresult.buckets[i].location); 获取到的桶列表将按照桶名字典顺序排列设置 QueryLocation 参数为 true 后, 可在列举桶时查询桶的区域位置 4.3 删除桶您可以通过 ObsClient.deleteBucket 删除桶以下代码展示如何删除一个桶 : 文档版本 07 ( ) 版权所有华为技术有限公司 18

25 4 管理桶 // 删除桶 obsclient.deletebucket({ Bucket : 'bucketname' console.error('error-->' + err); 如果桶不为空 ( 包含对象或分段上传碎片 ), 则该桶无法删除删除桶非幂等操作, 删除不存在的桶会失败 4.4 判断桶是否存在您可以通过 ObsClient.headBucket 接口判断该桶是否已存在以下代码展示如何判断指定桶是否存在 : obsclient.headbucket({ Bucket : 'bucketname' console.error('error-->' + err); if(result.commonmsg.status < 300){ console.log('bucket exists'); else if(result.commonmsg.status === 404){ console.log('bucket does not exist'); 如果返回的 HTTP 状态码为 404, 表明桶不存在 4.5 获取桶元数据您可以通过 ObsClient.getBucketMetadata 接口获取桶元数据以下代码展示如何获取桶元数据 : 文档版本 07 ( ) 版权所有华为技术有限公司 19

26 4 管理桶 // 获取桶元数据 obsclient.getbucketmetadata({ Origin : ' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('storageclass-->' + result.interfaceresult.storageclass); console.log('alloworigin-->' + result.interfaceresult.alloworigin); console.log('maxageseconds-->' + result.interfaceresult.maxageseconds); console.log('exposeheader-->' + result.interfaceresult.exposeheader); console.log('allowmethod-->' + result.interfaceresult.allowmethod); console.log('allowheader-->' + result.interfaceresult.allowheader); 4.6 管理桶访问权限桶访问权限 (ACL) 可以通过三种方式设置 : 1. 创建桶时指定预定义访问策略 2. 调用 ObsClient.setBucketAcl 指定预定义访问策略 3. 调用 ObsClient.setBucketAcl 直接设置 OBS 支持的桶或对象权限包含五类, 见下表 : 权限描述 OBS Node.js SDK 对应值读权限写权限读 ACP 权限若有桶的读权限, 则可以获取该桶内对象列表和桶的元数据若有对象的读权限, 则可以获取该对象内容和元数据若有桶的写权限, 则可以上传覆盖和删除该桶内任何对象此权限在对象上不适用若有读 ACP 的权限, 则可以获取对应的桶或对象的权限控制列表 (ACL) 桶或对象的所有者永远拥有读对应桶或对象 ACP 的权限 ObsClient.enums.Permissio nread ObsClient.enums.Permissio nwrite ObsClient.enums.Permissio nreadacp 文档版本 07 ( ) 版权所有华为技术有限公司 20

27 4 管理桶权限描述 OBS Node.js SDK 对应值写 ACP 权限完全控制权限若有写 ACP 的权限, 则可以更新对应桶或对象的权限控制列表 (ACL) 桶或对象的所有者永远拥有写对应桶或对象的 ACP 的权限拥有了写 ACP 的权限, 由于可以更改权限控制策略, 实际上意味着拥有了完全访问的权限若有桶的完全控制权限意味着拥有读权限写权限读 ACP 权限和写 ACP 权限的权限若有对象的完全控制权限意味着拥有读权限读 ACP 权限和写 ACP 权限的权限 ObsClient.enums.Permissio nwriteacp ObsClient.enums.Permissio nfullcontrol OBS 预定义的访问策略包含五类, 见下表 : 权限描述 OBS Node.js SDK 对应值私有读写公共读公共读写桶公共读, 桶内对象公共读桶或对象的所有者拥有完全控制的权限, 其他任何人都没有访问权限设在桶上, 所有人可以获取该桶内对象列表桶内多段任务桶的元数据桶的多版本设在对象上, 所有人可以获取该对象内容和元数据设在桶上, 所有人可以获取该桶内对象列表桶内多段任务桶的元数据上传对象删除对象初始化段任务上传段合并段拷贝段取消多段上传任务设在对象上, 所有人可以获取该对象内容和元数据设在桶上, 所有人可以获取该桶内对象列表桶内多段任务桶的元数据, 可以获取该桶内对象的内容和元数据不能应用于对象 ObsClient.enums.AclPrivate ObsClient.enums.AclPublic Read ObsClient.enums.AclPublic ReadWrite ObsClient.enums.AclPublic ReadDelivered 文档版本 07 ( ) 版权所有华为技术有限公司 21

28 4 管理桶权限描述 OBS Node.js SDK 对应值桶公共读写, 桶内对象公共读写设在桶上, 所有人可以获取该桶内对象列表桶内多段任务桶的元数据上传对象删除对象初始化段任务上传段合并段拷贝段取消多段上传任务, 可以获取该桶内对象的内容和元数据不能应用于对象 ObsClient.enums.AclPublic ReadWriteDelivered 创桶时指定预定义访问策略以下代码展示如何在创建桶时指定预定义访问策略 : // 创建桶 obsclient.createbucket({ // 设置桶访问权限为公共读写 ACL : obsclient.enums.aclpublicreadwrite console.error('error-->' + err); 为桶设置预定义访问策略以下代码展示如何为桶设置预定义访问策略 : // 用预定义访问策略设置桶权限 obsclient.setbucketacl({ // 设置桶访问权限为私有读写文档版本 07 ( ) 版权所有华为技术有限公司 22

29 4 管理桶 ACL : obsclient.enums.aclprivate console.error('error-->' + err); 使用 ACL 参数指定桶的访问权限直接设置桶访问权限获取桶访问权限以下代码展示如何直接设置桶访问权限 : // 直接设置桶访问权限 obsclient.setbucketacl({ // 设置桶所有者 Owner:{'ID':'ownerid', Grants:[ // 为指定用户设置完全控制权限 { Grantee : {Type : 'CanonicalUser',ID : 'userid', Permission : obsclient.enums.permissionfullcontrol, // 为所有用户设置读权限 { Grantee : {Type : 'Group',URI : obsclient.enums.groupallusers, Permission : obsclient.enums.aclpublicread ] console.error('error-->' + err); 使用 Owner 参数指定桶的所有者信息 ; 使用 Grants 参数指定被授权的用户信息 ACL 中需要填写的所有者 (Owner) 或者被授权用户 (Grantee) 的 ID, 是指用户的账户 ID, 可通过 OBS 控制台我的凭证页面查看当前 OBS 桶支持的可被授权的用户组为 : 所有用户 :ObsClient.enums.GroupAllUsers 您可以通过 ObsClient.getBucketAcl 获取桶的访问权限以下代码展示如何获取桶访问权限 : 文档版本 07 ( ) 版权所有华为技术有限公司 23

30 4 管理桶 obsclient.getbucketacl({ console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('requestid-->' + result.interfaceresult.requestid); console.log('owner[id]-->' + result.interfaceresult.owner.id); console.log('grants:'); for(let i=0;i<result.interfaceresult.grants.length;i++){ console.log('grant[' + i + ']:'); console.log('grantee[id]-->' + result.interfaceresult.grants[i] ['Grantee']['ID']); console.log('grantee[uri]-->' + result.interfaceresult.grants[i] ['Grantee']['URI']); console.log('permission-->' + result.interfaceresult.grants[i] ['Permission']); 4.7 管理桶策略除了桶访问权限外, 桶的拥有者还可以通过桶策略, 提供对桶和桶内对象的集中访问控制设置桶策略更多关于桶策略的内容请参考桶策略您可以通过 ObsClient.setBucketPolicy 设置桶策略示例代码如下 : // 设置桶策略 obsclient.setbucketpolicy({ Policy : 'your policy' 文档版本 07 ( ) 版权所有华为技术有限公司 24

31 4 管理桶 console.error('error-->' + err); 桶策略内容的具体格式 (JSON 格式字符串 ) 请参考 API 参考获取桶策略您可以通过 ObsClient.getBucketPolicy 获取桶策略示例代码如下 : // 获取桶策略 obsclient.getbucketpolicy({ console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('policy-->' + result.interfaceresult.policy); 删除桶策略您可以通过 ObsClient.deleteBucketPolicy 删除桶策略示例代码如下 : // 删除桶策略 obsclient.deletebucketpolicy({ Bucket : 'bucketname' console.error('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 25

32 4 管理桶 4.8 获取桶区域位置您可以通过 ObsClient.getBucketLocation 获取桶的区域位置以下代码展示如何获取桶区域位置 : obsclient.getbucketlocation({ console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('location-->' + result.interfaceresult.location); 创建桶时可以指定桶的区域位置, 请参见创建桶 4.9 获取桶存量信息桶存量信息包括桶的空间大小以及桶包含的对象个数您可以通过 ObsClient.getBucketStorageInfo 获取桶的存量信息以下代码展示如何获取桶存量信息 : obsclient.getbucketstorageinfo({ console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('size-->' + result.interfaceresult.size); console.log('objectnumber-->' + result.interfaceresult.objectnumber); 文档版本 07 ( ) 版权所有华为技术有限公司 26

33 4 管理桶 4.10 桶配额设置桶配额您可以通过 ObsClient.setBucketQuota 设置桶配额以下代码展示如何设置桶配额 : // 设置桶配额为 100MB obsclient.setbucketquota({ StorageQuota: 1024 * 1024 * 100 console.error('error-->' + err); 使用 StorageQuota 参数指定桶的配额大小桶配额值必须为非负整数, 单位为字节, 支持的最大值为获取桶配额您可以通过 ObsClient.getBucketQuota 获取桶配额以下代码展示如何获取桶配额 : obsclient.getbucketquota({ Bucket : 'bucketname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ 文档版本 07 ( ) 版权所有华为技术有限公司 27

34 4 管理桶 console.log('storagequota-->' + result.interfaceresult.storagequota); 4.11 桶存储类型 OBS 允许您对桶配置不同的存储类型, 桶中对象的存储类型默认将与桶的存储类型保持一致不同的存储类型可以满足客户业务对存储性能成本的不同诉求桶的存储类型分为三类, 见下表 : 类型 OBS Node.js SDK 对应值标准存储低频访问存储归档存储标准存储拥有低访问时延和较高的吞吐量, 适用于有大量热点对象 ( 平均一个月多次 ) 或小对象 (<1MB), 且需要频繁访问数据的业务场景低频访问存储适用于不频繁访问 ( 平均一年少于 12 次 ) 但在需要时也要求能够快速访问数据的业务场景归档存储适用于很少访问 ( 平均一年访问一次 ) 数据的业务场景 ObsClient.enums.Storage ClassStandard ObsClient.enums.Storage ClassWarm ObsClient.enums.Storage ClassCold 更多关于桶存储类型的内容请参考桶的存储类别设置桶存储类型您可以通过 ObsClient.setBucketStoragePolicy 设置桶存储类型以下代码展示如何设置桶存储类型 : obsclient.setbucketstoragepolicy({ StorageClass: obsclient.enums.storageclasswarm console.error('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 28

35 4 管理桶使用 StorageClass 参数指定桶的存储类型获取桶存储类型您可以通过 ObsClient.getBucketStoragePolicy 获取桶存储类型以下代码展示如何获取桶存储类型 : obsclient.getbucketstoragepolicy({ Bucket : 'bucketname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('storageclass-->' + result.interfaceresult.storageclass); 文档版本 07 ( ) 版权所有华为技术有限公司 29

36 5 上传对象 5 上传对象 5.1 对象上传简介在 OBS 中, 用户操作的基本数据单元是对象 OBS Node.js SDK 提供了丰富的对象上传接口, 可以通过以下方式上传对象 : 5.2 文本上传 5.3 流式上传 5.4 文件上传 5.7 分段上传 5.9 追加上传 5.11 断点续传上传 5.12 基于表单上传 SDK 支持上传 0kb~5GB 的对象文本上传流式上传文件上传和追加上传每次上传内容大小不能超过 5GB; 当上传较大文件时, 请使用分段上传, 分段上传每段内容大小不能超过 5GB; 基于表单上传提供了基于浏览器表单上传对象的方式若上传的对象权限设置为匿名用户读取权限, 对象上传成功后, 匿名用户可通过链接地址访问该对象数据对象链接地址格式为 : 桶名. 域名 / 文件夹目录层级 / 对象名如果该对象存在于桶的根目录下, 则链接地址将不需要有文件夹目录层级 5.2 文本上传文本上传用于直接上传字符串您可以通过 ObsClient.putObject 直接上传字符串到 OBS 以下代码展示了如何进行文本上传 : 文档版本 07 ( ) 版权所有华为技术有限公司 30

37 5 上传对象 obsclient.putobject({ Key : 'objectname', Body : 'Hello OBS' console.error('error-->' + err); 使用 Body 参数指定待上传的字符串上传内容大小不能超过 5GB 5.3 流式上传流式上传使用 stream.readable 作为对象的数据源以下代码展示了如何进行流式上传 : 上传网络流 var http = require('http'); // 创建网络流 http.get(' (res) => { obsclient.putobject({ Key : 'objectname', Body : res console.error('error-->' + err); 上传文件流文档版本 07 ( ) 版权所有华为技术有限公司 31

38 5 上传对象 var fs = require('fs'); obsclient.putobject({ Key : 'objectname', // 创建文件流, 其中 localfile 为待上传的本地文件路径, 需要指定到具体的文件名 Body : fs.createreadstream('localfile') console.error('error-->' + err); 使用 Body 参数指定待上传的流数据时, 其值必须是一个 stream.readable 实例大文件上传建议使用分段上传上传内容大小不能超过 5GB 5.4 文件上传文件上传使用本地文件作为对象的数据源以下代码展示了如何进行文件上传 : obsclient.putobject({ Key : 'objectname', SourceFile : 'localfile' // localfile 为待上传的本地文件路径, 需要指定到具体的文件名 console.error('error-->' + err); 使用 SourceFile 参数指定待上传的文件路径 SourceFile 参数和 Body 参数不能同时使用上传内容大小不能超过 5GB 文档版本 07 ( ) 版权所有华为技术有限公司 32

39 5 上传对象 5.5 创建文件夹 OBS 本身是没有文件夹的概念的, 桶中存储的元素只有对象创建文件夹实际上是创建了一个大小为 0 且对象名以 / 结尾的对象, 这类对象与其他对象无任何差异, 可以进行下载删除等操作, 只是 OBS 控制台会将这类以 / 结尾的对象以文件夹的方式展示 obsclient.putobject({ Key : 'parent_directory/' console.error('error-->' + err); // 在文件夹下创建对象 obsclient.putobject({ Key : 'parent_directory/objectname' console.error('error-->' + err); 创建文件夹本质上来说是创建了一个大小为 0 且对象名以 / 结尾的对象多级文件夹创建最后一级即可, 比如 src1/src2/src3/, 创建 src1/src2/src3/ 即可, 无需创建 src1/ src1/src2/ 5.6 设置对象属性您可以在上传对象时设置对象属性对象属性包含对象长度对象 MIME 类型对象 MD5 值 ( 用于校验 ) 对象存储类型对象自定义元数据对象属性可以在多种上传方式下 ( 文本上传流式上传文件上传分段上传 ), 或复制对象时进行设置对象属性详细见下表 : 文档版本 07 ( ) 版权所有华为技术有限公司 33

40 5 上传对象名称描述默认值对象长度 (Content- Length) 对象 MIME 类型 (Content- Type) 对象 MD5 值 (Content- MD5) 对象存储类型对象自定义元数据上传对象的长度, 超过流 / 文件的长度会截断对象的 MIME 类型, 定义对象的类型及网页编码, 决定浏览器将以什么形式什么编码读取对象对象数据的 MD5 值 ( 经过 Base64 编码 ), 提供给 OBS 服务端, 校验数据完整性对象的存储类型, 不同的存储类型可以满足客户业务对存储性能成本的不同诉求默认与桶的存储类型保持一致, 可以设置为与桶的存储类型不同用户对上传到桶中对象的自定义属性描述, 以便对对象进行自定义管理流 / 文件实际长度 binary/octet-stream 无无无设置对象长度 obsclient.putobject({ Key : 'objectname', SourceFile : 'localfile', ContentLength : 1024 * 1024 // 1MB console.error('error-->' + err); 设置对象 MIME 类型使用 ContentLength 参数指定对象长度文档版本 07 ( ) 版权所有华为技术有限公司 34

41 5 上传对象 // 上传图片 obsclient.putobject({ Key : 'objectname.jpg', SourceFile : 'localimage.jpg', ContentType : 'image/jpeg' console.error('error-->' + err); 使用 ContentType 参数指定对象 MIME 类型如果不设置对象 MIME 类型,SDK 会根据上传对象的后缀名自动判断对象 MIME 类型, 如.xml 判断为 application/xml 文件 ;.html 判断为 text/html 文件设置对象 MD5 值 obsclient.putobject({ Key : 'objectname', SourceFile : 'localimage.jpg', ContentMD5 : 'your md5 which should be encoded by base64' console.error('error-->' + err); 使用 ContentMD5 参数指定对象 MD5 值对象数据的 MD5 值必须经过 Base64 编码 OBS 服务端会将该 MD5 值与对象数据计算出的 MD5 值进行对比, 如果不匹配则上传失败, 返回 HTTP 400 错误如果不设置对象的 MD5 值,OBS 服务端会忽略对对象数据的 MD5 值校验文档版本 07 ( ) 版权所有华为技术有限公司 35

42 5 上传对象设置对象存储类型 obsclient.putobject({ Key : 'objectname', SourceFile : 'localfile', // 设置对象存储类型为归档存储 StorageClass : ObsClient.enums.StorageClassCold console.error('error-->' + err); 设置对象自定义元数据使用 StorageClass 参数指定对象的存储类型如果不设置, 对象的存储类型默认与桶的存储类型保持一致对象的存储类型分为三类, 其含义与桶存储类型一致下载归档存储类型的对象前必须将其取回 obsclient.putobject({ Key : 'objectname', SourceFile : 'localfile', Metadata : {'property1':'property-value1', 'property2' : 'property-value2', console.error('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 36

43 5 上传对象使用 Metadata 参数指定对象自定义元数据在上面设置对象自定义元数据示例代码中, 用户自定义了一个名称为 property1, 值为 property-value1 的元数据和一个名称为 property2, 值为 property-value2 的元数据一个对象可以有多个元数据, 总大小不能超过 8KB 对象的自定义元数据可以通过 ObsClient.getObjectMetadata 获取, 参见获取对象元数据使用 ObsClient.getObject 下载对象时, 对象的自定义元数据也会同时下载 5.7 分段上传对于较大文件上传, 可以切分成段上传用户可以在如下的应用场景内 ( 但不仅限于此 ), 使用分段上传的模式 : 上传超过 100MB 大小的文件网络条件较差, 和 OBS 服务端之间的链接经常断开上传前无法确定将要上传文件的大小分段上传分为如下 3 个步骤 : 步骤 1 初始化分段上传任务 (ObsClient.initiateMultipartUpload) 步骤 2 逐个或并行上传段 (ObsClient.uploadPart) 步骤 3 合并段 (ObsClient.completeMultipartUpload) 或取消分段上传任务 (ObsClient.abortMultipartUpload) ---- 结束初始化分段上传任务使用分段上传方式传输数据前, 必须先通知 OBS 初始化一个分段上传任务该操作会返回一个 OBS 服务端创建的全局唯一标识 (Upload ID), 用于标识本次分段上传任务您可以根据这个唯一标识来发起相关的操作, 如取消分段上传任务列举分段上传任务列举已上传的段等您可以通过 ObsClient.initiateMultipartUpload 初始化一个分段上传任务 : obsclient.initiatemultipartupload({ Key : 'objectname', ContentType : 'text/plain', Metadata : {'property' : 'property-value' 文档版本 07 ( ) 版权所有华为技术有限公司 37

44 5 上传对象 console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('uploadid-->' + result.interfaceresult.uploadid); 初始化分段上传任务时, 除了指定上传对象的名称和所属桶外, 您还可以使用 ContentType 参数和 Metadata 参数分别指定对象 MIME 类型和对象自定义元数据调用初始化分段上传任务接口成功后, 会返回分段上传任务的全局唯一标识 (Upload ID), 在后面的操作中将用到它上传段初始化一个分段上传任务之后, 可以根据指定的对象名和 Upload ID 来分段上传数据每一个上传的段都有一个标识它的号码分段号 (Part Number, 范围是 1~10000) 对于同一个 Upload ID, 该分段号不但唯一标识这一段数据, 也标识了这段数据在整个对象内的相对位置如果您用同一个分段号上传了新的数据, 那么 OBS 上已有的这个段号的数据将被覆盖除了最后一段以外, 其他段的大小范围是 100KB~5GB; 最后段大小范围是 0~5GB 每个段不需要按顺序上传, 甚至可以在不同进程不同机器上上传,OBS 会按照分段号排序组成最终对象您可以通过 ObsClient.uploadPart 上传段 : obsclient.uploadpart({ Bucket:'bucketname', Key:'objectname', // 设置分段号, 范围是 1~10000 PartNumber:1, // 设置 Upload ID UploadId:'upload id from initiatemultipartupload', // 设置将要上传的大文件, 其中 localfile 为待上传的本地文件路径, 需要指定到具体的文件名 SourceFile: 'localfile', // 设置分段大小 PartSize: 5 * 1024 * 1024, // 设置分段的起始偏移大小 Offset: 0 console.log('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('etag-->' + result.interfaceresult.etag); 文档版本 07 ( ) 版权所有华为技术有限公司 38

45 5 上传对象使用 PartNumber 参数指定分段号 ; 使用 UploadId 参数指定分段上传任务的全局唯一标识 ; 使用 SourceFile 参数指定待上传的文件 ; 使用 PartSize 参数指定分段大小 ; 使用 Offset 参数指定待上传文件的起始偏移大小上传段接口要求除最后一段以外, 其他的段大小都要大于 100KB 但是上传段接口并不会立即校验上传段的大小 ( 因为不知道是否为最后一块 ); 只有调用合并段接口时才会校验 OBS 会将服务端收到段数据的 ETag 值 ( 段数据的 MD5 值 ) 返回给用户可以通过 ContentMD5 参数设置上传数据的 MD5 值, 提供给 OBS 服务端用于校验数据完整性分段号的范围是 1~10000 如果超出这个范围,OBS 将返回 400 Bad Request 错误 OBS 3.0 的桶支持最小段的大小为 100KB,OBS 2.0 的桶支持最小段的大小为 5MB 请在 OBS 3.0 的桶上执行分段上传操作合并段所有分段上传完成后, 需要调用合并段接口来在 OBS 服务端生成最终对象在执行该操作时, 需要提供所有有效的分段列表 ( 包括分段号和分段 ETag 值 );OBS 收到提交的分段列表后, 会逐一验证每个段的有效性当所有段验证通过后,OBS 将把这些分段组合成最终的对象您可以通过 ObsClient.completeMultipartUpload 合并段 : obsclient.completemultipartupload({ Bucket:'bucketname', Key:'objectname', // 设置 Upload ID UploadId:'upload id from initiatemultipartupload', Parts: [{'PartNumber':1,'ETag':'etag value from uploadpart'] console.log('error-->' + err); 使用 UploadId 参数指定分段上传任务的全局唯一标识 ; 使用 Parts 参数指定分段号与分段 ETag 值的列表, 该列表必须按分段号升序排列分段可以是不连续的并发分段上传分段上传的主要目的是解决大文件上传或网络条件较差的情况下面的示例代码展示了如何使用分段上传并发上传大文件 : 文档版本 07 ( ) 版权所有华为技术有限公司 39

46 5 上传对象 // 初始化分段上传任务 obsclient.initiatemultipartupload({ Key : 'objectname' if(!err && result.commonmsg.status < 300){ var uploadid = result.interfaceresult.uploadid; console.log('\t' + uploadid + '\n'); // 每段上传 100MB var partsize = 100 * 1024 * 1024; var fs = require('fs'); var samplefilepath = 'localfile'; var filelength = fs.lstatsync(samplefilepath).size; // 计算需要上传的段数 var partcount = filelength % partsize === 0? Math.floor(fileLength / partsize) : Math.floor(fileLength / partsize) + 1; var events = require('events'); var eventemitter = new events.eventemitter(); var parts = []; // 指定并发上传 for(let i=0;i<partcount;i++){ // 分段在文件中的起始位置 let offset = i * partsize; // 分段大小 let currpartsize = (i + 1 === partcount)? filelength - offset : partsize; // 分段号 let partnumber = i + 1; obsclient.uploadpart({ Key: 'objectname', PartNumber: partnumber, UploadId : uploadid, SourceFile: samplefilepath, Offset : offset, PartSize : currpartsize if(!err && result.commonmsg.status < 300){ parts.push({partnumber : partnumber, ETag : result.interfaceresult.etag if(parts.length === partcount){ // 按分段号排序 var _parts = parts.sort((a, b) => { if(a.partnumber >= b.partnumber){ return 1; return -1; eventemitter.emit('upload part finished', _parts); throw new Error(err result.commonmsg.code); 文档版本 07 ( ) 版权所有华为技术有限公司 40

47 5 上传对象 // 等待上传完成 eventemitter.on('upload part finished', (parts) => { // 合并段 obsclient.completemultipartupload({ Key: 'objectname', UploadId: uploadid, Parts: parts console.log('error-->' + err); 大文件分段上传时, 使用 Offset 参数和 PartSize 参数配合指定每段数据在文件中的起始结束位置取消分段上传任务分段上传任务可以被取消, 当一个分段上传任务被取消后, 就不能再使用其 Upload ID 做任何操作, 已经上传段也会被 OBS 删除采用分段上传方式上传对象过程中或上传对象失败后会在桶内产生段, 这些段会占用您的存储空间, 您可以通过取消该分段上传任务来清理掉不需要的段, 节约存储空间您可以通过 ObsClient.abortMultipartUpload 取消分段上传任务 : obsclient.abortmultipartupload({ Bucket:'bucketname', Key:'objectname', // 设置 Upload ID UploadId:'upload id from initiatemultipartupload', console.log('error-->' + err); 文档版本 07 ( ) 版权所有华为技术有限公司 41

48 5 上传对象列举已上传的段您可使用 ObsClient.listParts 列举出某一分段上传任务所有已经上传成功的段该接口可设置的参数如下 : 参数 UploadId MaxParts PartNumberMarker 作用分段上传任务全局唯一标识, 从 ObsClient.initiateMultipartUpload 返回的结果获取表示列举已上传段的返回结果最大段数目, 即分页时每一页中段数目表示列举已上传段的起始位置, 只有 Part Number 大于该参数的段会被列出简单列举 // 列举已上传的段, 其中 uploadid 来自于 initiatemultipartupload obsclient.listparts({ Key: 'objectname', UploadId : 'upload id from initiatemultipartupload' console.log('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ for(let i=0;i<result.interfaceresult.parts.length;i++){ console.log('part['+ i +']:'); // 分段号, 上传时候指定 console.log('partnumber-->' + result.interfaceresult.parts[i] ['PartNumber']); // 段的最后上传时间 console.log('lastmodified-->' + result.interfaceresult.parts[i] ['LastModified']); // 分段的 ETag 值 console.log('etag-->' + result.interfaceresult.parts[i]['etag']); // 段数据大小 console.log('size-->' + result.interfaceresult.parts[i]['size']); 文档版本 07 ( ) 版权所有华为技术有限公司 42

49 5 上传对象列举段至多返回 1000 个段信息, 如果指定的 Upload ID 包含的段数量大于 1000, 则返回结果中 InterfaceResult.IsTruncated 为 true 表明本次没有返回全部段, 并可通过 InterfaceResult.NextPartNumberMarker 获取下次列举的起始位置如果想获取指定 Upload ID 包含的所有分段, 可以采用分页列举的方式列举所有段由于 ObsClient.listParts 只能列举至多 1000 个段, 如果段数量大于 1000, 列举所有分段请参考如下示例 : var listall = (partnumbermarker) => { // 列举已上传的段, 其中 uploadid 来自于 initiatemultipartupload obsclient.listparts({ Key: 'objectname', UploadId : 'upload id from initiatemultipartupload', PartNumberMarker : partnumbermarker console.log('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ for(let i=0;i<result.interfaceresult.parts.length;i++){ console.log('part['+ i +']:'); // 分段号, 上传时候指定 console.log('partnumber-->' + result.interfaceresult.parts[i] ['PartNumber']); // 段的最后上传时间 console.log('lastmodified-->' + result.interfaceresult.parts[i] ['LastModified']); // 分段的 ETag 值 console.log('etag-->' + result.interfaceresult.parts[i]['etag']); // 段数据大小 console.log('size-->' + result.interfaceresult.parts[i]['size']); if(result.interfaceresult.istruncated === 'true'){ listall(result.interfaceresult.nextpartnumbermarker); ; listall(); 列举分段上传任务您可以通过 ObsClient.listMultipartUploads 列举分段上传任务列举分段上传任务可设置的参数如下 : 文档版本 07 ( ) 版权所有华为技术有限公司 43

50 5 上传对象参数 Prefix Delimiter MaxUploads KeyMarker UploadIdMarker 作用限定返回的分段上传任务中的对象名必须带有 Prefix 前缀用于对分段上传任务中的对象名进行分组的字符对于对象名中包含 Delimiter 的任务, 其对象名 ( 如果请求中指定了 Prefix, 则此处的对象名需要去掉 Prefix) 中从首字符至第一个 Delimiter 之间的字符串将作为一个分组并作为 CommonPrefix 返回列举分段上传任务的最大数目, 取值范围为 1~1000, 当超出范围时, 按照默认的 1000 进行处理表示列举时返回指定的 KeyMarker 之后的分段上传任务只有与 KeyMarker 参数一起使用时才有意义, 用于指定返回结果的起始位置, 即列举时返回指定 KeyMarker 的 UploadIdMarker 之后的分段上传任务简单列举分段上传任务 obsclient.listmultipartuploads({ Bucket : 'bucketname' console.log('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ for(let i=0;i<result.interfaceresult.uploads.length;i++){ console.log('uploads[' + i + ']'); console.log('uploadid-->' + result.interfaceresult.uploads[i] ['UploadId']); console.log('key-->' + result.interfaceresult.uploads[i]['key']); console.log('initiated-->' + result.interfaceresult.uploads[i] ['Initiated']); 列举分段上传任务至多返回 1000 个任务信息, 如果指定的桶包含的分段上传任务数量大于 1000, 则返回结果中 InterfaceResult.IsTruncated 为 true 表明本次没有返回全部结果, 并可通过 InterfaceResult.NextKeyMarker 和 InterfaceResult.NextUploadIdMarker 获取下次列举的起点如果想获取指定桶包含的所有分段上传任务, 可以采用分页列举的方式列举全部分段上传任务文档版本 07 ( ) 版权所有华为技术有限公司 44

51 5 上传对象 var listall = (keymarker, uploadidmarker) => { obsclient.listmultipartuploads({ KeyMarker : keymarker, UploadIdMarker : uploadidmarker console.log('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ for(let i=0;i<result.interfaceresult.uploads.length;i++){ console.log('uploads[' + i + ']'); console.log('uploadid-->' + result.interfaceresult.uploads[i] ['UploadId']); console.log('key-->' + result.interfaceresult.uploads[i]['key']); console.log('initiated-->' + result.interfaceresult.uploads[i] ['Initiated']); if(result.interfaceresult.istruncated === 'true'){ listall(result.interfaceresult.nextkeymarker, result.interfaceresult.nextuploadidmarker); listall(); 5.8 设置对象生命周期上传对象或者初始化分段上传任务时, 您可以直接指定对象的过期时间示例代码如下 : // 上传对象时, 设置对象 30 天后过期 obsclient.putobject({ Key : 'objectname', Body : 'Hello OBS', Expires : 30 文档版本 07 ( ) 版权所有华为技术有限公司 45

52 5 上传对象 console.error('error-->' + err); // 初始化分段上传任务时, 设置合并段后生成的对象 60 天后过期 obsclient.initiatemultipartupload({ Key : 'objectname', ContentType : 'text/plain', Expires : 60 console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('uploadid-->' + result.interfaceresult.uploadid); 使用 Expires 参数指定对象的过期时间上述方式仅支持设置以天为单位的对象过期时间, 过期后的对象会被 OBS 服务端自动清理上述方式设置的对象过期时间, 其优先级高于桶生命周期规则 5.9 追加上传追加上传可实现对同一个对象追加数据内容的功能您可以通过 ObsClient.appendObject 进行追加上传示例代码如下 : // 第一次追加上传, 起始位置必须为 0 obsclient.appendobject({ Bucket:'bucketname', Key:'objectname', Position : 0, Body : 'Hello OBS' ).then(function(result){ if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('nextposition-->' + result.interfaceresult.nextposition); // 第二次追加上传 obsclient.appendobject({ Bucket:'bucketname', Key:'objectname', Position : result.interfaceresult.nextposition, Body : 'Hello OBS Again', function(err, result2){ 文档版本 07 ( ) 版权所有华为技术有限公司 46

53 5 上传对象 console.error('error-->' + err); console.log('status-->' + result2.commonmsg.status); if(result2.commonmsg.status < 300 && result2.interfaceresult){ console.log('nextposition-->' + result2.interfaceresult.nextposition); // 通过获取对象属性接口获取下次追加上传的位置 obsclient.getobjectmetadata({ Bucket:'bucketname', Key:'objectname', ).then(function(result3){ console.log('status-->' + result3.commonmsg.status); if(result3.commonmsg.status < 300 && result3.interfaceresult){ console.log('requestid-->' + result3.interfaceresult.requestid); console.log('nextposition-->' + result3.interfaceresult.nextposition); ).catch(function(err){ console.error('err:' + err); ).catch(function(err){ console.error('err:' + err); 使用 Position 参数指定追加上传的位置, 且第一次追加上传的位置必须为 0 ObsClient.putObject 上传的对象可覆盖 ObsClient.appendObject 上传的对象, 覆盖后对象变为普通对象, 不可再进行追加上传第一次调用追加上传时, 若已存在同名的普通对象, 则会抛出异常 (HTTP 状态码为 409) 追加上传返回的 ETag 是当次追加数据内容的 ETag, 不是完整对象的 ETag 单次追加上传的内容不能超过 5GB, 且最多支持次追加上传追加上传成功后, 可通过返回结果中 InterfaceResult.NextPosition 获取下次追加上传的位置 ; 或者通过 ObsClient.getObjectMetadata 接口获取下次追加上传的位置 5.10 分段复制分段复制是分段上传的一种特殊情况, 即分段上传任务中的段通过复制 OBS 指定桶中现有对象 ( 或对象的一部分 ) 来实现您可以通过 ObsClient.copyPart 来复制段以下代码展示了如何使用分段复制模式复制大对象 : var destbucketname = 'destbucketname'; var destobjectkey = 'destobjectname'; var sourcebucketname = 'sourcebucketname'; var sourceobjectkey = 'sourceobjectname'; // 初始化分段上传任务 obsclient.initiatemultipartupload({ 文档版本 07 ( ) 版权所有华为技术有限公司 47

54 5 上传对象 Bucket : destbucketname, Key : destobjectkey if(!err && result.commonmsg.status < 300){ var uploadid = result.interfaceresult.uploadid; console.log('\t' + uploadid + '\n'); // 获取大对象信息 obsclient.getobjectmetadata({ Bucket : sourcebucketname, Key : sourceobjectkey if(!err && result.commonmsg.status < 300){ // 每段复制 100MB var partsize = 100 * 1024 * 1024; var objectsize = Number(result.InterfaceResult.ContentLength); // 计算需要复制的段数 var partcount = objectsize % partsize === 0? Math.floor(objectSize / partsize) : Math.floor(objectSize / partsize) + 1; var events = require('events'); var eventemitter = new events.eventemitter(); var parts = []; // 执行并发复制段 for(let i=0;i<partcount;i++){ let rangestart = i * partsize; let rangeend = (i + 1) === partcount? objectsize - 1 : rangestart + partsize - 1; let partnumber = i + 1; obsclient.copypart({ Bucket: destbucketname, Key: destobjectkey, PartNumber : partnumber, UploadId : uploadid, CopySource: sourcebucketname + '/' + sourceobjectkey, CopySourceRange : 'bytes=' + rangestart + '-' + rangeend if(!err && result.commonmsg.status < 300){ parts.push({partnumber : partnumber, ETag : result.interfaceresult.etag if(parts.length === partcount){ var _parts = parts.sort((a, b) => { if(a.partnumber >= b.partnumber){ return 1; return -1; eventemitter.emit('copy part finished', _parts); throw new Error(err result.commonmsg.code); // 等待复制完成 eventemitter.on('copy part finished', (parts) => { // 合并段 obsclient.completemultipartupload({ Bucket: destbucketname, Key: destobjectkey, UploadId: uploadid, Parts: parts if(!err && result.commonmsg.status < 300){ console.log('complete to upload multiparts 文档版本 07 ( ) 版权所有华为技术有限公司 48

55 5 上传对象 finished.\n'); 复制段时, 使用 PartNumber 参数指定分段号 ; 使用 UploadId 参数指定分段上传任务的全局唯一标识 ; 使用 CopySource 参数指定复制时的源对象信息 ; 使用 CopySourceRange 参数指定待复制的源对象的字节范围 5.11 断点续传上传当上传大文件时, 经常出现因网络不稳定或程序崩溃导致上传失败的情况失败后再次重新上传不仅浪费资源, 而且当网络不稳定时仍然有上传失败的风险断点续传上传接口能有效地解决此类问题引起的上传失败, 其原理是将待上传的文件分成若干个分段分别上传, 并实时地将每段上传结果统一记录在 checkpoint 文件中, 仅当所有分段都上传成功时返回上传成功的结果, 否则在回调函数中返回错误码提醒用户再次调用接口进行重新上传 ( 重新上传时因为有 checkpoint 文件记录当前的上传进度, 避免重新上传所有分段, 从而节省资源提高效率 ) 您可以通过 ObsClient.uploadFile 进行断点续传上传该接口可设置的主要参数如下 : 参数 Bucket Key UploadFile PartSize 作用桶名, 必选参数对象名, 必选参数待上传的本地文件, 必选参数分段大小, 单位字节, 取值范围是 100KB~5GB, 默认为 5MB TaskNum 分段上传时的最大并发数, 默认为 20 EnableCheckpoint CheckpointFile EnableCheckSum 是否开启断点续传模式, 默认为 false, 表示不开启记录上传进度的文件, 只在断点续传模式下有效当该值为空时, 默认与待上传的本地文件同目录是否校验待上传文件的内容, 只在断点续传模式下有效默认为 false, 表示不校验以下代码展示了如何使用断点续传上传接口上传文件 : 文档版本 07 ( ) 版权所有华为技术有限公司 49

56 5 上传对象 access_key_id : '*** Provide your Access Key ***', secret_access_key : '*** Provide your Secret Key ***', obsclient.uploadfile({ Key : 'objectname', // 设置待上传的本地文件,localfile 为待上传的本地文件路径, 需要指定到具体的文件名 UploadFile : 'localfile', // 设置分段大小为 10MB PartSize : 10 * 1024 * 1024, // 开启断点续传模式 EnableCheckpoint : true console.error('error-->' + err); console.log('requestid-->' + result.interfaceresult.requestid); console.log('bucket-->' + result.interfaceresult.bucket); console.log('key-->' + result.interfaceresult.key); console.log('location-->' + result.interfaceresult.location); 断点续传上传接口是利用分段上传特性实现的, 是对分段上传的封装和加强断点续传上传接口不仅能在失败重传时节省资源提高效率, 还因其对分段进行并发上传的机制能加快上传速度, 能帮助用户快速完成上传业务 ; 且其对用户透明, 用户不用关心 checkpoint 文件的创建和删除分段任务的切分并发上传的实现等内部细节 EnableCheckpoint 参数默认是 false, 代表不启用断点续传模式, 此时断点续传上传接口退化成对分段上传的简单封装, 不会产生 checkpoint 文件 CheckpointFile 参数和 EnableCheckSum 参数仅在 EnableCheckpoint 参数为 true 时有效 5.12 基于表单上传基于表单上传是使用 HTML 表单形式上传对象到指定桶中, 对象最大不能超过 5GB 您可以通过 ObsClient.createPostSignatureSync 生成基于表单上传的请求参数使用 Node.js 代码模拟表单上传的完整代码示例, 参见 post-object-sample 您也可以通过如下步骤进行表单上传 : 步骤 1 步骤 2 步骤 3 步骤 4 使用 ObsClient.createPostSignatureSync 生成用于鉴权的请求参数准备表单 HTML 页面将生成的请求参数填入 HTML 页面选择本地文件, 进行表单上传 ---- 结束使用 SDK 生成用于鉴权的请求参数包括两个 : Policy, 对应表单中 policy 字段 Signature, 对应表单中的 signature 字段以下代码展示了如何生成基于表单上传的请求参数 : 文档版本 07 ( ) 版权所有华为技术有限公司 50

57 5 上传对象 server : ' signature : 'obs' // 设置表单参数 var formparams = { // 设置对象访问权限为公共读 'x-obs-acl': obsclient.enums.aclpublicread, // 设置对象 MIME 类型 'content-type': 'text/plain', ; // 设置表单上传请求有效期, 单位 : 秒 var expires = 3600; var res = obsclient.createpostsignaturesync({expires:expires, FormParams: formparams // 获取表单上传请求参数 console.log('\t' + res.policy); console.log('\t' + res.signature); 示例表单 HTML 代码如下 : <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> </head> <body> <form action=" method="post" enctype="multipart/form-data"> Object key  <input type="text" name="key" value="objectname" /> <p> ACL  <input type="text" name="x-obs-acl" value="public-read" /> <p> Content-Type  <input type="text" name="content-type" value="text/plain" /> <p>  <input type="hidden" name="policy" value="*** Provide your policy ***" />  <input type="hidden" name="accesskeyid" value="*** Provide your access key ***"/>  <input type="hidden" name="signature" value="*** Provide your signature ***"/> <input name="file" type="file" /> <input name="submit" value="upload" type="submit" /> </form> </body> </html> HTML 表单中的 policy,signature 的值均是从 ObsClient.createPostSignatureSync 的返回结果中获取您可以直接下载表单 HTML 示例 PostDemo 文档版本 07 ( ) 版权所有华为技术有限公司 51

58 6 下载对象 6 下载对象 6.1 对象下载简介 OBS Node.js SDK 提供了丰富的对象下载接口, 可以通过以下方式下载对象 : 6.2 文本下载 6.3 流式下载 6.4 文件下载 6.5 范围下载 6.10 断点续传下载您可以通过 ObsClient.getObject 下载对象 6.2 文本下载以下代码展示了如何进行文本下载 : obsclient.getobject({ Key : 'objectname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 读取对象内容 console.log('object Content:'); 文档版本 07 ( ) 版权所有华为技术有限公司 52

59 6 下载对象 console.log(result.interfaceresult.content.tostring()); 文本下载方式下返回结果中的 InterfaceResult.Content 是一个 Buffer 对象 6.3 流式下载以下代码展示了如何进行流式下载 : obsclient.getobject({ Key : 'objectname', SaveAsStream : true console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 读取对象内容 console.log('object Content:\n'); result.interfaceresult.content.on('data', (data) => { console.log(data.tostring()); 使用 SaveAsStream 参数指定使用流式下载 InterfaceResult.Content 是 stream.readable 的实例, 可将对象的内容读取到本地文件或者内存中 6.4 文件下载以下代码展示了如何进行文件下载 : 文档版本 07 ( ) 版权所有华为技术有限公司 53

60 6 下载对象 obsclient.getobject({ Key : 'objectname', SaveAsFile : 'localfile' console.error('error-->' + err); 使用 SaveAsFile 参数指定文件下载的路径 6.5 范围下载如果只需要下载对象的其中一部分数据, 可以使用范围下载, 下载指定范围的数据如果指定的下载范围是 0~1000, 则返回第 0 到第 1000 个字节的数据, 包括第 1000 个, 共 1001 字节的数据, 即 [0,1000] 如果指定的范围无效, 则返回整个对象的数据以下代码展示了如何进行范围下载 : obsclient.getobject({ Key : 'objectname', // 指定下载范围 Range : 'bytes=0-1000' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 读取对象内容 console.log('object Content:'); console.log(result.interfaceresult.content.tostring()); 使用 Range 参数指定下载范围, 格式为 bytes=x-y 如果指定的范围无效 ( 比如开始位置结束位置为负数, 大于文件大小 ), 则会返回整个对象可以利用范围下载并发下载大对象, 详细代码示例请参考 concurrent-download-objectsample 文档版本 07 ( ) 版权所有华为技术有限公司 54

61 6 下载对象 6.6 限定条件下载下载对象时, 可以指定一个或多个限定条件, 满足限定条件时则进行下载, 否则返回异常码, 下载对象失败您可以使用的限定条件如下 : 参数作用格式 IfModifiedSince IfUnmodifiedSince IfMatch 如果对象的修改时间晚于该参数值指定的时间, 则返回对象内容, 否则返回异常码如果对象的修改时间早于该参数值指定的时间, 则返回对象内容, 否则返回异常码如果对象的 ETag 值与该参数值相同, 则返回对象内容, 否则返回异常码符合 rfc2616.txt 规定格式的 HTTP 时间字符串符合 rfc2616.txt 规定格式的 HTTP 时间字符串字符串 IfNoneMatch 如果对象的 ETag 值与该参数值不相同, 则返回对象内容, 否则返回异常码字符串对象的 ETag 值是指对象数据内容的 MD5 校验值如果包含 IfUnmodifiedSince 并且不符合或者包含 IfMatch 并且不符合, 则下载对象失败, 返回异常码 :412 precondition failed 如果包含 IfModifiedSince 并且不符合或者包含 IfNoneMatch 并且不符合, 则下载对象失败, 返回异常码 :304 Not Modified 以下代码展示了如何进行限定条件下载 : obsclient.getobject({ Key : 'objectname', IfModifiedSince : 'Wed, 04 Jul :54:53 GMT' 文档版本 07 ( ) 版权所有华为技术有限公司 55

62 6 下载对象 console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 读取对象内容 console.log('object Content:'); console.log(result.interfaceresult.content.tostring()); 6.7 重写响应头下载对象时, 可以重写部分 HTTP/HTTPS 响应头信息可重写的响应头信息见下表 : 参数 ResponseContentType ResponseContentLanguage ResponseExpires ResponseCacheControl ResponseContentDisposition ResponseContentEncoding 作用重写 HTTP/HTTPS 响应中的 Content-Type 重写 HTTP/HTTPS 响应中的 Content-Language 重写 HTTP/HTTPS 响应中的 Expires 重写 HTTP/HTTPS 响应中的 Cache-Control 重写 HTTP/HTTPS 响应中的 Content-Disposition 重写 HTTP/HTTPS 响应中的 Content-Encoding 以下代码展示了如何重写响应头 : obsclient.getobject({ Key : 'objectname', ResponseContentType : 'image/jpeg' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 获取重写后的响应头 console.log(result.interfaceresult.contenttype); 文档版本 07 ( ) 版权所有华为技术有限公司 56

63 6 下载对象 6.8 获取自定义元数据下载对象成功后会返回对象的自定义元数据以下代码展示了如何获取自定义元数据 : // 下载对象, 获取对象自定义元数据 obsclient.getobject({ Key : 'objectname', console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ console.log('metadata-->' + JSON.stringify(result.InterfaceResult.Metadata['property'])); 6.9 下载归档存储对象如果要下载归档存储对象, 需要先将归档存储对象取回取回归档存储对象的取回选项可支持两类, 见下表 : 选项 OBS Node.js SDK 对应值快速取回取回耗时 1~5 分钟 ObsClient.enums.RestoreTie rexpedited 标准取回取回耗时 3~5 小时默认值 ObsClient.enums.RestoreTie rstandard 您可以通过 ObsClient.restoreObject 取回归档存储对象以下代码展示了如何下载归档存储对象 : 文档版本 07 ( ) 版权所有华为技术有限公司 57

64 6 下载对象 // 取回归档存储对象 obsclient.restoreobject({ Key : 'objectname', Days : 1, Tier : obsclient.enums.restoretierexpedited console.error('error-->' + err); // 等待对象取回 settimeout(()=>{ // 下载对象, 获取对象内容 obsclient.getobject({ Key : 'objectname' console.error('error-->' + err); if(result.commonmsg.status < 300 && result.interfaceresult){ // 读取对象内容 console.log('object Content:'); console.log(result.interfaceresult.content.tostring());, 6 * 60 * 1000); ObsClient.restoreObject 中指定的对象必须是归档存储类型, 否则调用该接口会报错使用 Days 参数指定取回对象保存的时间, 取值范围是 1~30; 使用 Tier 参数指定取回选项, 表示取回对象所耗的时间 6.10 断点续传下载当下载大对象到本地文件时, 经常出现因网络不稳定或程序崩溃导致下载失败的情况失败后再次重新下载不仅浪费资源, 而且当网络不稳定时仍然有下载失败的风险断点续传下载接口能有效地解决此类问题引起的下载失败, 其原理是将待下载的对象分成若干个分段分别下载, 并实时地将每段下载结果统一记录在 checkpoint 文件中, 仅当所有分段都下载成功时返回下载成功的结果, 否则在回调函数中返回错误码提醒用户再次调用接口进行重新下载 ( 重新下载时因为有 checkpoint 文件记录当前的下载进度, 避免重新下载所有分段, 从而节省资源提高效率 ) 您可以通过 ObsClient.downloadFile 进行断点续传下载该接口可设置的主要参数如下 : 参数 Bucket 作用桶名, 必选参数文档版本 07 ( ) 版权所有华为技术有限公司 58

65 6 下载对象参数 Key DownloadFile PartSize 作用对象名, 必选参数下载对象的本地文件全路径当该值为空时, 默认为当前程序的运行目录分段大小, 单位字节, 取值范围是 100KB~5GB, 默认为 5MB TaskNum 分段下载时的最大并发数, 默认为 20 EnableCheckpoint CheckpointFile VersionId IfModifiedSince IfUnmodifiedSince IfMatch IfNoneMatch 是否开启断点续传模式, 默认为 false, 表示不开启记录下载进度的文件, 只在断点续传模式下有效当该值为空时, 默认与下载对象的本地文件路径同目录对象的版本号如果对象的修改时间晚于该参数值指定的时间, 则返回对象内容, 否则返回异常码如果对象的修改时间早于该参数值指定的时间, 则返回对象内容, 否则返回异常码如果对象的 ETag 值与该参数值相同, 则返回对象内容, 否则返回异常码如果对象的 ETag 值与该参数值不相同, 则返回对象内容, 否则返回异常码以下代码展示了如何使用断点续传下载接口下载对象到本地文件 : access_key_id : '*** Provide your Access Key ***', secret_access_key : '*** Provide your Secret Key ***', obsclient.downloadfile({ Key : 'objectname', // 设置下载对象的本地文件路径 DownloadFile : 'localfile', // 设置分段大小为 10MB PartSize : 10 * 1024 * 1024, // 开启断点续传模式 EnableCheckpoint : true console.error('error-->' + err); console.log('requestid-->' + result.interfaceresult.requestid); console.log('lastmodified-->' + result.interfaceresult.lastmodified); console.log('metadata-->' + JSON.stringify(result.InterfaceResult.Metadata)); 文档版本 07 ( ) 版权所有华为技术有限公司 59

展开

javascript sdk javascript sdk 列出 Bucket 内的对象上传 textarea 内容到 Bucket 上传本地文件生成私有下载链接生成带过期时间的私有链接删除对象下载对象拷贝对象查看文件访问权限设置文件访问权限获取静态网站配置设置静态网站删除静态网站查询对象元数据查询

javascript sdk javascript sdk 列出 Bucket 内的对象上传 textarea 内容到 Bucket 上传本地文件生成私有下载链接生成带过期时间的私有链接删除对象下载对象拷贝对象查看文件访问权限设置文件访问权限获取静态网站配置设置静态网站删除静态网站查询对象元数据查询桶的多版本 Bucket 开启对象多版本支持挂起 Bucket 的多版本对象功能浏览器客户端浏览器客户端的