# 文件上传(Node.js SDK) ![](https://support.huaweicloud.com/sdk-nodejs-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-nodejs-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 #### 功能说明 本章节介绍上传单个对象到指定桶中。 #### 接口约束 - 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见[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://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。 - 单次上传对象大小范围是\[0, 5GB\]。 - 如果需要上传超过5GB的大文件，需要使用[分段上传](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1901.html)。 #### 方法定义 ``` ObsClient.putObject(params) ``` #### 请求参数 表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的字符串。 **默认取值：** 无 | | ACL | [AclType] | 可选 | **参数解释** **：** 创建对象时可指定的预定义访问策略，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见[ACL功能介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。 **约束限制：** 无 **取值范围：** 可选择的访问策略选项参见[AclType]。 **默认取值：** 无 | | StorageClass | [StorageClassType] | 可选 | **参数解释：** 创建对象时，可以加上此头域设置对象的存储类别。 **约束限制：** 无 **取值范围：** 可选择的存储类别参见[StorageClassType]。 **默认取值：** 如果未设置此头域，则对象的存储列表默认为桶存储类别。 | | Body | string \| stream.Readable | 可选 | **参数解释：** 待上传段的内容，支持字符串和stream.Readable对象。 **约束限制：** - 单次上传对象大小范围是\[0, 5GB\]。 - 如果需要上传超过5GB的大文件，需要使用[分段上传](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1901.html)。 - Body与SourceFile不能同时使用。 **取值范围：** 无 **默认取值：** 无 | | SourceFile | string | 可选 | **参数解释：** 待上传对象的源文件路径。 **约束限制：** - 单次上传大小范围是\[0, 5GB\]。 - Body与SourceFile不能同时使用。 - Offset和SourceFile配套使用，用于指定上传源文件中的某一部分数据。 **取值范围：** 无 **默认取值：** 无 | | Offset | number | 可选 | **参数解释：** 源文件中某一分段的起始偏移大小。 **约束限制：** Offset和SourceFile配套使用，用于指定上传源文件中的某一部分数据。 **取值范围：** 非负整数，小于待上传对象的大小，单位：字节。 **默认取值：** 0 | | ProgressCallback | function | 可选 | **参数解释：** 获取上传进度的回调函数。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒）。 | | ContentMD5 | string | 可选 | **参数解释：** 待上传对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 **约束限制：** 消息体128-bit MD5值经过base64编码后得到的字符串。 **取值范围：** 按照RFC 1864标准计算出消息体的MD5摘要字符串，即消息体128-bit MD5值经过base64编码后得到的字符串。 示例：n58IG6hfM7vqI4K0vnWpog==。 **默认取值：** 无 | | WebsiteRedirectLocation | string | 可选 | **参数解释：** 当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据"WebsiteRedirectLocation"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 **取值范围：** 无 **默认取值：** 无 | | ContentType | string | 可选 | **参数解释：** 待上传对象的文件类型（MIME类型）。Content-Type（MIME）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。 **约束限制：** 无 **取值范围：** 常见的Content-Type（MIME）列表参见[如何理解Content-Type（MIME）(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1716.html) **默认取值：** 如果您在上传Object时未指定Content-Type，SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。 | | ContentLength | int64 | 可选 | **参数解释：** 待上传对象数据的长度。 **约束限制：** - 单次上传对象大小范围是\[0，5GB\]。 - 如果需要上传超过5GB的大文件，需要使用[分段上传](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1901.html) **取值范围：** \[0, 5GB\]。 **默认取值：** 如果不传，则sdk会自动计算上传对象数据的长度。 | | SseKms | string | 当使用SSE-KMS方式时，必选 | **参数解释：** 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 **约束限制：** 当前仅支持kms。 **取值范围：** 可选值：kms，即选择SSE-KMS方式加密对象。 **默认取值：** 无 | | SseKmsKey | string | 可选 | **参数解释：** SSE-KMS加密方式下使用的KMS主密钥的ID值。 **约束限制：** 有效值支持两种格式： 1. regionID:domainID(账号ID):key/key_id 2. key_id 其中： - regionID是使用密钥所属region的ID，可在[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)页面获取； - domainID是使用密钥所属账号的账号ID，获取方法参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html)； - key_id是从数据加密服务创建的密钥ID，获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **取值范围：** 无 **默认取值：** - 如果用户没有提供该头域，那么默认的主密钥将会被使用。 - 如果默认主密钥不存在，将默认创建并使用。 | | SseC | string | 当使用SSE-C方式时，必选 | **参数解释：** 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 **约束限制：** 仅支持AES256。 **取值范围：** 可选值：AES256，即选择SSE-C方式加密对象。 **默认取值：** 无 | | SseCKey | string | 当使用SSE-C方式时，必选 | **参数解释：** SSE-C方式下加密使用的密钥，该密钥用于加密对象。 **约束限制：** 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= **取值范围：** 无 **默认取值：** 无 | | 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 **取值范围：** 无 **默认取值：** 无 | | GrantRead | string | 可选 | **参数解释：** 被授予READ权限的账号的账号ID，即domain_id。账号被授予READ权限后，针对当前对象，允许被授权指定账号有读对象和获取对象元数据的权限。 **约束限制：** 如果授权给多个租户，需要通过","分隔。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantReadAcp | string | 可选 | **参数解释：** 被授予READ_ACP权限的账号的账号ID，即domain_id。账号被授予READ_ACP权限后，针对当前对象，允许读对象的ACL。 **约束限制：** 如果授权给多个租户，需要通过","分隔。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantWriteAcp | string | 可选 | **参数解释：** 被授予WRITE_ACP权限的账号的账号ID，即domain_id。账号被授予WRITE_ACP权限后，针对当前对象，允许修改对象的ACL信息。 **约束限制：** 如果授权给多个租户，需要通过","分隔。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | GrantFullControl | string | 可选 | **参数解释：** 被授予FULL_CONTROL权限的账号的账号ID，即domain_id。账号被授予FULL_CONTROL权限后，针对当前对象，授权指定账号有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 **约束限制：** 如果授权给多个租户，需要通过","分隔。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1715.html) **默认取值：** 无 | | Expires | number | 可选 | **参数解释：** 表示对象的过期时间（从对象最后修改时间开始计算），过期之后对象会被自动删除。 **约束限制：** - 设置的天数计算出的过期时间不能早于当前时间，如10天前上传的对象，不能设置小于10的值。 - 此字段对于每个对象仅支持上传时配置，不支持后期通过修改元数据接口修改。 **取值范围：** 1\~（2^63^-1），单位：天。 **默认取值：** 无 | 表2AclType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.AclPrivate | private | 私有读写。 桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 | | ObsClient.enums.AclPublicRead | public-read | 公共读私有写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上，所有人可以获取该对象内容和元数据。 | | ObsClient.enums.AclPublicReadWrite | public-read-write | 公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务。 设在对象上，所有人可以获取该对象内容和元数据。 | | ObsClient.enums.AclPublicReadDelivered | public-read-delivered | 桶公共读，桶内对象公共读。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadDelivered不能应用于对象。 | | ObsClient.enums.AclPublicReadWriteDelivered | public-read-write-delivered | 桶公共读写，桶内对象公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadWriteDelivered不能应用于对象。 | | ObsClient.enums.AclBucketOwnerFullControl | bucket-owner-full-control | 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。 默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后，用户B就拥有了对象x的控制权。 | 表3StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.StorageClassStandard | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | ObsClient.enums.StorageClassWarm | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | ObsClient.enums.StorageClassCold | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | 无 | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景 | #### 返回结果 表4返回结果 | **参数类型** | 描述 | |:---|:---| | [表5] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表5]。 | 表5Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [表7] | **参数解释：** 操作成功后的结果数据，详见[表7]。 **约束限制：** 当Status大于300时为空。 | 表6ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | 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服务端返回的详细错误码。 | 表7PutObjectOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | StorageClass | [StorageClassType] | **参数解释：** 对象的存储类别。 **取值范围：** - 当对象存储类别是标准存储时，该值为空。 - 可选择的存储类别参见[StorageClassType]。 | | VersionId | string | **参数解释：** 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 | | ETag | string | **参数解释：** 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 **约束限制：** 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 | | 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== | 表8StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.StorageClassStandard | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | ObsClient.enums.StorageClassWarm | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | ObsClient.enums.StorageClassCold | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | 无 | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景 | #### 代码示例 文件上传使用本地文件作为对象的数据源。以下代码展示了如何通过文件上传至名为examplebucket桶中。 ``` // 引入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 putObject() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象名，此处以 example/objectname 为例 Key: "example/objectname", // localfile为待上传的本地文件路径，需要指定到具体的文件名 SourceFile : 'localfile' }; // 文件上传 const result = await obsClient.putObject(params); if (result.CommonMsg.Status <= 300) { console.log("Put bucket(%s) successful!", params.Bucket); console.log("RequestId: %s", result.CommonMsg.RequestId); 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); }; }; putObject(); ```