华为云用户手册

配置SDK日志(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。 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日志的信息。 父主题： 初始化(Node.js SDK)

配置密钥(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 要接入OBS服务，您需要拥有一组有效的访问密钥（AK和SK）用来进行签名认证。具体可参考OBS服务环境搭建。 获取AK和SK之后，可以通过创建OBS客户端，调用SDK接口。 获取AK和SK之后，您便可以按照以下步骤进行初始化。 创建OBS客户端(Node.js SDK) 配置OBS客户端(Node.js SDK) 配置SDK日志(Node.js SDK) 配置SDK代理(Node.js SDK) 父主题： 初始化(Node.js SDK)

通过构造函数创建 永久访问密钥（AK/SK）创建OBS客户端代码如下： // 引入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.AC CES S_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 server: "https://obs.cn-north-4.myhuaweicloud.com",});// 使用访问OBS// 关闭obsClient// obsClient.close(); 临时访问密钥（AK/SK/SecurityToken）创建OBS客户端代码如下： // 引入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",});// 使用访问OBS// 关闭obsClient// obsClient.close();

通过工厂方法创建 永久访问密钥（AK/SK）创建OBS客户端代码如下： // 引入obs库// 使用npm安装var ObsClient = require('esdk-obs-nodejs');// 使用源码安装// var ObsClient = require('./lib/obs');// 通过工厂方法初始化ObsClient实例var obsClient = new ObsClient();obsClient.factory({ // 推荐通过环境变量获取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, // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 server: "https://obs.cn-north-4.myhuaweicloud.com",});// 使用访问OBS// 关闭obsClient// obsClient.close(); 临时访问密钥（AK/SK/SecurityToken）创建OBS客户端代码如下： // 引入obs库// 使用npm安装var ObsClient = require('esdk-obs-nodejs');// 使用源码安装// var ObsClient = require('./lib/obs');// 通过工厂方法初始化ObsClient实例var obsClient = new ObsClient();obsClient.factory({ // 推荐通过环境变量获取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",});// 使用访问OBS// 关闭obsClient// obsClient.close(); 您的工程中可以有多个obsClient实例，也可以只有一个。 obsClient实例在调用close方法关闭后不能再次使用。 配置SDK代理请参见配置SDK代理(Node.js SDK)。

获取服务地址(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 您可以从这里查看OBS当前开通的服务地址和区域信息。 SDK支持带协议名和不带协议名两种方式传入服务地址，例如获取到的服务地址为“your-endpoint”，则初始化OBS客户端时传入的服务地址可以为“http://your-endpoint”、“https://your-endpoint”和“your-endpoint”三种形式。 父主题： 快速入门(Node.js SDK)

配置SDK代理(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 在项目工程根目录下使用npm命令下载proxy-agent依赖包。 npm install --save proxy-agent 在项目工程里面声明并配置代理。 const ProxyAgent = require("proxy-agent");const proxyAgent = new ProxyAgent(`http://username:password@proxyhost:proxyPort`); 在项目工程里面初始化OBS客户端并配置代理。 var 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", https_agent:proxyAgent, http_agent: proxyAgent,}); 父主题： 初始化(Node.js SDK)

返回结果说明 表3 返回结果 参数类型 描述 表4 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表4。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult ListBucketsOutput 参数解释： 操作成功后的结果数据，详见ListBucketsOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 ListBucketsOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 Owner Owner 参数解释： 桶的所有者。 取值范围： 桶所有者取值参见Owner。 Buckets Bucket[] 参数解释： 桶信息列表。 取值范围： 桶信息取值参见Bucket。 表7 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无 表8 Bucket 参数名称 参数类型 描述 BucketName string 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 默认取值： 无 CreationDate string 参数解释： 桶的创建时间。 默认取值： 无 Location string 参数解释： 桶所在的区域。 约束限制： 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 取值范围： 当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 默认取值： 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。 BucketType string 参数解释： 桶类型。 取值范围： 对象桶：OBJECT 并行文件系统：POSIX。 默认取值： 无

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 QueryLocation boolean 可选 参数解释： 是否同时查询桶的区域位置。 约束限制： 无 取值范围： true：同时查询桶的区域位置 false：不查询桶的区域位置 默认取值： false BucketType string 可选 参数解释： 列举指定类型的桶。 约束限制： 无 取值范围： 桶类型取值可参见BucketType。 默认取值： 无，如果不赋值则默认获取所有桶和并行文件系统列表。 表2 BucketType 可选值 说明 OBJECT 对应类型为对象存储桶。 POSIX 对应类型为并行文件系统（POSIX）。

初始化OBS客户端(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 向OBS发送任一HTTP/HTTPS请求之前，必须先创建一个ObsClient实例： // 引入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",});// 使用访问OBS// 关闭obsClient// obsClient.close(); 由于JavaScript是异步编程语言，所以不能在访问OBS期间调用close方法。 obsClient在调用obsClient.close方法关闭后不能再次使用。 更多关于OBS客户端初始化的内容请参考“初始化”章节。 日志配置详见配置SDK日志。 代理配置详见配置SDK代理(Node.js SDK)。 父主题： 快速入门(Node.js SDK)

使用前需知(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 请确认您已经熟悉OBS的基本概念，如桶（Bucket）、对象（Object）、访问密钥（AK和SK）等。 您可以先参考OBS客户端通用示例，了解OBS Node.js SDK接口调用的通用方式。 OBS客户端支持回调函数和Promise对象两种方式返回调用结果。 当前各区域特性开放不一致，部分特性只在部分区域开放，使用过程中如果接口HTTP状态码为405，请确认该区域是否支持该功能特性。 父主题： 快速入门(Node.js SDK)

接口约束 您必须是桶拥有者或拥有获取桶的多版本状态的权限，才能获取桶的多版本状态。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketVersioning权限，如果使用桶策略则需授予GetBucketVersioning权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数 表1 BucketRequestInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 GetBucketVersioningOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 VersionStatus string 参数解释： 桶的多版本状态。

返回结果 表3 返回结果 参数类型 描述 表4 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表4。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表6 参数解释： 操作成功后的结果数据，详见表6。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

接口约束 您必须是桶拥有者或拥有恢复归档或深度归档存储对象的权限，才能恢复归档或深度归档存储对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:RestoreObject权限，如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 重复恢复归档或深度归档存储对象时在延长恢复有效期的同时，也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长，并且收取延长时间段产生的标准存储副本费用。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 约束限制： ObsClient.restoreObject中指定的对象必须是归档存储类别，否则调用该接口会报错。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 参数解释： 待恢复归档存储或深度归档对象的版本号。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无，如果不设置则默认指定最新版本的对象。 Days number 必选 参数解释： 恢复对象后，会生成一个对象的标准存储副本，此参数指定恢复有效期，即标准存储副本的保存时间。 约束限制： 无 取值范围： [1, 30]，单位：天。 默认取值： 无 Tier RestoreTierType 可选 参数解释： 恢复选项，用户可根据需求选择恢复选项，不同的恢复选项恢复耗时不同。 约束限制： 无 取值范围： 恢复选项可选值详见RestoreTierType。 默认取值： Standard，即标准恢复。 表2 RestoreTierType 常量名 原始值 说明 ObsClient.enums.RestoreTierExpedited Expedited 快速恢复，归档存储恢复耗时1~5 min，深度归档（受限公测）存储恢复约耗时3~5 h。 ObsClient.enums.RestoreTierStandard Standard 标准恢复，归档存储恢复耗时3~5 h，深度归档（受限公测）存储恢复约耗时5~12 h。 说明： 对于深度归档对象，大批量恢复建议使用标准恢复，且对象最终恢复时间受对象大小以及取回数据量的影响。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 GetObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释： 标识删除的对象是否是删除标记。 LastModified string 参数解释： 对象的最近一次修改时间。 ContentLength string 参数解释： 对象数据的长度。 CacheControl string 参数解释： 响应中的Cache-Control头。 ContentDisposition string 参数解释： 响应中的Content-Disposition头。 ContentEncoding string 参数解释： 响应中的Content-Encoding头 ContentLanguage string 参数解释： 响应中的Content-Language头 ContentType string 参数解释： 对象的MIME类型。 Expires string 参数解释： 响应中的Expires头。 ETag string 参数解释： 对象的ETag值。 VersionId string 参数解释： 对象的版本号。 WebsiteRedirectLocation string 参数解释： 当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释： 对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释： 归档存储类型对象的恢复状态。 Expiration string 参数解释： 对象的详细过期信息。 Content string | stream.Readable 参数解释： 对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata object 参数解释： 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 VersionStatus string 必选 参数解释： 桶的多版本状态。 约束限制： 无 取值范围： 桶的多版本状态，支持的值： Enabled：启用 Suspended：暂停 默认取值： 无

接口约束 您必须是桶拥有者或拥有设置桶的多版本状态的权限，才能设置桶的多版本状态。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketVersioning权限，如果使用桶策略则需授予PutBucketVersioning权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见 表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

接口约束 您必须是桶拥有者或拥有删除对象的权限，才能删除对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:DeleteObject权限，如果使用桶策略则需授予DeleteObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 桶没有开启多版本控制功能时，已删除的对象不可恢复，请谨慎操作。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 约束限制： 无 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 参数解释： 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker boolean 参数解释： 标识删除的对象是否是删除标记。 取值范围： true：是删除标记。 false：不是删除标记。 VersionId string 参数解释： 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 DownloadFileOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释： 标识删除的对象是否是删除标记。 LastModified string 参数解释： 对象的最近一次修改时间。 CacheControl string 参数解释： 响应中的Cache-Control头。 ContentDisposition string 参数解释： 响应中的Content-Disposition头。 ContentEncoding string 参数解释： 响应中的Content-Encoding头 ContentLanguage string 参数解释： 响应中的Content-Language头 ContentType string 参数解释： 对象的MIME类型。 Expires string 参数解释： 响应中的Expires头。 ETag string 参数解释： 对象的ETag值。 VersionId string 参数解释： 对象的版本号。 WebsiteRedirectLocation string 参数解释： 当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释： 对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释： 归档存储类型对象的恢复状态。 Expiration string 参数解释： 对象的详细过期信息。 Metadata object 参数解释： 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。 SseKms string 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 SseKmsKey string 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 SseC string 参数解释： 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 SseCKeyMd5 string 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==

功能说明 断点续传下载接口是利用范围下载特性实现的，是对范围下载的封装和加强，当下载大对象到本地文件时，经常出现因网络不稳定或程序崩溃导致下载失败的情况。失败后再次重新下载不仅浪费资源，而且当网络不稳定时仍然有下载失败的风险。断点续传下载接口能有效地解决此类问题引起的下载失败，其原理是将待下载的对象分成若干个分段分别下载，并实时地将每段下载结果统一记录在checkpoint文件中，仅当所有分段都下载成功时返回下载成功的结果，否则在回调函数中返回错误码提醒用户再次调用接口进行重新下载（重新下载时因为有checkpoint文件记录当前的下载进度，避免重新下载所有分段，从而节省资源提高效率）。 断点续传下载接口不仅能在失败重下时节省资源提高效率，还因其对分段进行并发下载的机制能加快下载速度，帮助用户快速完成下载业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发下载的实现等内部细节。

请求参数 表1 请求参数列表 参数名称 类型 是否必选 说明 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 约束限制： 无 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 参数解释： 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 DownloadFile string 可选 参数解释： 下载对象的本地文件全路径。当该值为空时，默认为当前程序的运行目录。 约束限制： 包含文件名，如aa/bb.txt 取值范围： 无 默认取值： 无 PartSize number 可选 参数解释： 当前段的长度。 约束限制： 无 取值范围： 100KB~5GB，单位：字节。 默认取值： 102400字节 TaskNum number 可选 参数解释： 分段下载时的最大并发数。 约束限制： 无 取值范围： 1~10000 默认取值： 1，即不设置则默认串行下载。 ProgressCallback function 可选 参数解释： 获取下载进度的回调函数。 说明： 该回调函数依次包含三个参数：已下载的字节数、总字节数、已使用的时间（单位：秒）。 约束限制： 无 取值范围： 无 默认取值： 无 ResumeCallback function 可选 参数解释： 获取取消断点续传控制参数的回调函数。 约束限制： 无 取值范围： 无 默认取值： 无 说明： 该回调函数有一个参数：取消断点续传下载任务控制参数； 可以调用取消断点续传下载任务控制参数的cancel方法来暂停断点续传下载任务。 EnableCheckpoint boolean 可选 参数解释： 是否开启断点续传模式。 约束限制： 无 取值范围： true：开启断点续传模式。 false：关闭断点续传模式，此时断点续传下载接口退化成对分段下载的简单封装，不会产生checkpoint文件 默认取值： false CheckpointFile string 可选 参数解释： 断点续传过程中，会生成一个进度记录文件，文件中会记录段的下载进度和段的相关信息。checkpointFile参数为该记录文件的文件路径。 约束限制： 仅在断点续传模式下有效。 取值范围： 无 默认取值： 当该值为空时，默认为待下载的本地文件的同级目录。 IfMatch string 可选 参数解释： 指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 IfModifiedSince string 可选 参数解释： 如果对象的修改时间晚于该参数值指定的时间，则返回对象内容，否则返回异常码。 约束限制： 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 取值范围： 无 默认取值： 无 IfNoneMatch string 可选 参数解释： 指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 IfUnmodifiedSince string 可选 参数解释： 如果对象的修改时间早于该参数值指定的时间，则返回对象内容，否则返回异常码。 约束限制： 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 取值范围： 无 默认取值： 无 SseC string 当使用SSE-C方式时，必选 参数解释： 以SSE-C方式解密对象。 约束限制： 仅支持AES256。 取值范围： 可选值：AES256。 默认取值： 无 SseCKey string 当使用SSE-C方式时，必选 参数解释： SSE-C方式下解密的密钥，该密钥用于解密对象。 约束限制： 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= 取值范围： 无 默认取值： 无 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。

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

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表5 ListObjectsOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 Location string 参数解释： 桶所在的区域。 Bucket string 参数解释： 桶名。 Prefix string 参数解释： 对象名的前缀，与请求中的该参数对应。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀，将返回以字符串“logs/”开头的三个对象。如果您指定空的前缀且请求中没有其他过滤条件，将返回桶中的所有对象。 Marker string 参数解释： 列举对象的起始位置，与请求中的该参数对应。列举桶内对象列表时，指定一个标识符，从该标识符以后按对象名的字典顺序返回对象列表。 Delimiter string 参数解释： 对象名按照此标识符进行分组。通常与prefix参数搭配使用，如果指定了prefix，从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes；如果没有指定prefix，从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes。 例如，桶中有3个对象，分别为abcd、abcde、bbcde。如果指定delimiter为d，prefix为a，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes；如果只指定delimiter为d，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes，而bbcde会被单独分成一组，形成一条前缀为bbcd的CommonPrefixes。 对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置[delimiter=/]，只列举当前目录下的内容，不列举子目录，提高列举效率。 MaxKeys number 参数解释： 列举对象的最大数目，与请求中的该参数对应。返回的对象列表将是按照字典顺序的最多前MaxKeys个对象。 IsTruncated string 参数解释： 表明本次请求是否返回了全部结果。因为每次列举返回对象的数量上限是1000个，如果对象个数大于1000，则无法通过一次请求返回全部结果。 取值范围： true：表示没有返回全部结果。 false：表示已返回了全部结果。 NextMarker string 参数解释： 下次列举对象请求的起始位置。如果本次没有返回全部结果，响应请求中将包含此字段，用于标明本次请求列举到的最后一个对象。后续请求可以指定Marker参数等于该值来列举剩余的对象。 Contents Content[] 参数解释： 桶内对象列表，详见Content。 CommonPrefixes CommonPrefix[] 参数解释： 当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。 取值范围： 详见CommonPrefix。 EncodingType string 参数解释： 对响应中的部分元素进行指定类型的编码。如果Delimiter、Marker、Prefix、CommonPrefixes、NextMarker和Key包含xml 1.0标准不支持的控制字符（特殊字符），需设置该参数为url编码。 表6 Content 参数名称 参数类型 描述 Key string 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 LastModified string 参数解释： 对象最近一次被修改的时间（UTC时间）。 ETag string 参数解释： 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 Size number 参数解释： 对象的字节数。 Owner Owner 参数解释： 对象的所有者，包含对象拥有者DomainId和对象拥有者名称，详见Owner。 StorageClass string 参数解释： 对象的存储类型。 Type string 参数解释： 对象的类型。 取值范围： NORMAL：普通对象 APPENDABLE：追加写对象 表7 CommonPrefix 参数名称 参数类型 描述 Prefix string 参数解释： 为桶内对象的前缀。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 表8 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无

接口约束 每次接口调用最多返回1000个对象信息。 您必须是桶拥有者或拥有列举桶内对象的权限，才能列举桶内对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:ListBucket权限，如果使用桶策略则需授予ListBucket权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。