# 上传对象(HarmonyOS SDK) #### 功能说明本章节介绍上传单个对象到指定桶中。 #### 接口约束 - 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用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://developer.huaweicloud.com/endpoint?OBS)。 - 单次上传对象大小范围是\[0, 5GB\]。 - 如果需要上传超过5GB的大文件，需要通过[多段操作](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0412.html)来分段上传。 - 该接口仅支持上传文本和ArrayBuffer 类型，如果需要上传文件，请参考[生成带授权信息的表单上传参数(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0502.html)。 #### 方法定义 ``` putObject(input: PutObjectInput): Response ``` #### 请求参数表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [PutObjectInput] | 必选 | **参数解释：** 上传对象接口入参，详见[PutObjectInput]。 | 表2PutObjectInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | 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的字符串。 **默认取值：** 无 | | Body | string \| ArrayBuffer | 可选 | **参数解释：** 待上传对象的数据流。 **约束限制：** - 单次上传对象大小范围是\[0, 5GB\]。 - 如果需要上传超过5GB的大文件，需要通过[多段操作](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0621.html)来分段上传。 **默认取值：** 无 | | SourceFile | string | 可选 | **参数解释：** 待上传对象的本地文件路径，与 Body 二选一。设置后 SDK 自动读取文件内容上传。 **默认取值：** 无 | | NeedCalculateCrc64 | boolean | 可选 | **参数解释：** 是否计算上传对象的 CRC64 校验值，用于数据完整性校验。 **默认取值：** 无 | | ContentMD5 | string | 可选 | **参数解释：** 待上传对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 **取值范围：** 按照RFC 1864标准计算出消息体的MD5摘要字符串，即消息体128-bit MD5值经过base64编码后得到的字符串。示例：n58IG6hfM7vqI4K0vnWpog==。 **默认取值：** 无 | | Acl | [AclType] | 可选 | **参数解释** **：** 创建对象时可指定的预定义ACL，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见[ACL功能介绍](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0005.html)。 **取值范围：** 可选择的配置选项参见[AclType]。 **默认取值：** 无 | | 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）](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0604.html)。 **默认取值：** 如果您在上传Object时未指定Content-Type，SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。 | | ContentLength | number | 可选 | **参数解释：** 待上传对象数据的长度。 **约束限制：** - 单次上传对象大小范围是\[0, 5GB\]。 - 如果需要上传超过5GB的大文件，需要通过[多段操作](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0412.html)来分段上传。 **默认取值：** 如果不传，则sdk会自动计算上传对象数据的长度。 | | SseKms | string | 作为请求参数时必选 | **参数解释：** 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 **取值范围：** 可选值：kms，即选择SSE-KMS方式加密对象。 **默认取值：** 无 | | SseKmsKey | string | 作为请求参数时可选 | **参数解释：** SSE-KMS加密方式下使用的KMS主密钥的ID值。 **取值范围：** 有效值支持两种格式： 1. regionID:domainID(账号ID):key/key_id 2. key_id 其中： - regionID是使用密钥所属region的ID，可在[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)页面获取； - domainID是使用密钥所属账号的账号ID，获取方法参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html)； - key_id是从数据加密服务创建的密钥ID，获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **默认取值：** - 如果用户没有提供该头域，那么默认的主密钥将会被使用。 - 如果默认主密钥不存在，将默认创建并使用。 | | SseC | string | 作为请求参数时必选 | **参数解释：** 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 **取值范围：** 可选值：AES256，即选择SSE-C方式加密对象。 **默认取值：** 无 | | SseCKey | string | 作为请求参数时必选 | **参数解释：** SSE-C方式下加密使用的密钥，该密钥用于加密对象。 **约束限制：** 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=。 **默认取值：** 无 | | SseCKeyMd5 | string | 作为请求参数时可选 | **参数解释：** SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 **约束限制：** 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==。 **默认取值：** 无 | | StorageClass | [StorageClassType] | 可选 | **参数解释：** 创建对象时，可以加上此头域设置对象的存储类型。 **取值范围：** 可选择的存储类型参见[StorageClassType]。 **默认取值：** 如果未设置此头域，则以桶的默认存储类型作为对象的存储类型。 | | 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？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | GrantReadAcp | string | 可选 | **参数解释：** 被授予READ_ACP权限的账号的账号ID，即domain_id。账号被授予READ_ACP权限后，针对当前对象，允许读对象的ACL。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | GrantWriteAcp | string | 可选 | **参数解释：** 被授予WRITE_ACP权限的账号的账号ID，即domain_id。账号被授予WRITE_ACP权限后，针对当前对象，允许修改对象的ACL信息。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | GrantFullControl | string | 可选 | **参数解释：** 被授予FULL_CONTROL权限的账号的账号ID，即domain_id。账号被授予FULL_CONTROL权限后，针对当前对象，授权指定账号有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 **取值范围：** 获取账号ID的方法请参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | Expires | number | 可选 | **参数解释：** 表示对象的过期时间（从对象最后修改时间开始计算），过期之后对象会被自动删除。 **取值范围：** 1\~（2^63^-1），单位：天。 **默认取值：** 无 | 表3AclType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | PRIVATE | private | 私有读写。桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 | | PUBLIC_READ | public-read | 公共读私有写。设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。设在对象上，所有人可以获取该对象内容和元数据。 | | PUBLIC_READ_WRITE | public-read-write | 公共读写。设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务。设在对象上，所有人可以获取该对象内容和元数据。 | | PUBLIC_READ_DELIVERED | public-read-delivered | 桶公共读，桶内对象公共读。设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。说明： AclPublicReadDelivered不能应用于对象。 | | PUBLIC_READ_WRITE_DELIVERED | public-read-write-delivered | 桶公共读写，桶内对象公共读写。设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务，可以获取该桶内对象的内容和元数据。说明： AclPublicReadWriteDelivered不能应用于对象。 | | BUCKET_OWNER_FULL_CONTROL | bucket-owner-full-control | 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后，用户B就拥有了对象x的控制权。 | 表4StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 返回结果表5返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明：该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表6Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [PutObjectOutput] | **参数解释：** 操作成功后的结果数据，详见[PutObjectOutput]。 **约束限制：** 当Status大于300时为空。 | 表7ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | 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服务端返回的详细错误码。 | 表8PutObjectOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | StorageClass | [StorageClassType] | **参数解释：** 对象的存储类型。 **取值范围：** - 当对象存储类型是标准存储时，该值为空。 - 可选择的存储类型参见[StorageClassType]。 **默认取值：** 无 | | VersionId | string | **参数解释：** 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | ETag | string | **参数解释：** 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 **约束限制：** 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | SseKms | string | **参数解释：** 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 **取值范围：** 可选值：kms，即选择SSE-KMS方式加密对象。 **默认取值：** 无 | | SseKmsKey | string | **参数解释：** SSE-KMS加密方式下使用的KMS主密钥的ID值。 **取值范围：** 有效值支持两种格式： 1. regionID:domainID(账号ID):key/key_id 2. key_id 其中： - regionID是使用密钥所属region的ID，可在[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)页面获取； - domainID是使用密钥所属账号的账号ID，获取方法参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html)； - key_id是从数据加密服务创建的密钥ID，获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **默认取值：** - 如果用户没有提供该头域，那么默认的主密钥将会被使用。 - 如果默认主密钥不存在，将默认创建并使用。 | | SseC | string | **参数解释：** 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 **取值范围：** 可选值：AES256，即选择SSE-C方式加密对象。 **默认取值：** 无 | | SseCKeyMd5 | string | **参数解释：** SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 **约束限制：** 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==。 **默认取值：** 无 | 表9StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。适用于长期不访问（平均几年访问一次）数据的业务场景。 | #### 代码示例-文本上传上传字符串"Hello OBS"，上传后的对象命名为example/objectname，对象存储在名为examplebucket的桶中。 ``` // 引入依赖包 import ObsClient, { PutObjectInput } 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 putObject() { try { const params: PutObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象，此处以 example/objectname 为例 Key: "example/objectname", // 指定上传内容 Body: 'Hello OBS' }; // 上传对象 const result = await obsClient.putObject(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Put object(%s) under the bucket(%s) successful!!", params.Key, params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); hilog.info(0x0001, 'OBS-Harmony', "StorageClass:%s, ETag:%s", result.InterfaceResult.StorageClass, result.InterfaceResult.ETag); 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); return; } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } putObject(); ``` #### 代码示例-二进制文件上传二进制文件上传，上传后的对象命名为example/objectname，对象存储在名为examplebucket的桶中。 ``` // 引入依赖包 import ObsClient, { PutObjectInput } from '@obs/esdk-obs-harmony'; import { fileIo as fs } from '@kit.CoreFileKit'; 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 putObject() { // 指定文件路径，这里以cacheDir目录下的hello.txt为例，需要保证fs模块可以正常读取。 let sourceFile = getContext().cacheDir + "/hello.txt"; // 打开文件句柄，如果代码运行在生产环境上，推荐加上异常捕获（try...catch）逻辑。 let file = fs.openSync(sourceFile, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE | fs.OpenMode.TRUNC); // 模拟文件内容 fs.writeSync(file.fd, "Hello OBS"); // 获取文件属性 let fileStat = fs.statSync(file.fd); // 根据文件大小构建文件缓冲区 let buf = new ArrayBuffer(fileStat.size); fs.readSync(file.fd, buf, { offset: 0 }); // 用完记得关闭文件 fs.closeSync(file.fd); try { const params: PutObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象，此处以 example/objectname 为例 Key: "example/objectname", // 指定上传内容，注意这里接收的类型是ArrayBuffer Body: buf }; // 上传对象 const result = await obsClient.putObject(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Put object(%s) under the bucket(%s) successful!!", params.Key, params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); hilog.info(0x0001, 'OBS-Harmony', "StorageClass:%s, ETag:%s", result.InterfaceResult.StorageClass, result.InterfaceResult.ETag); 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); return; } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } putObject(); ``` #### 代码示例-新建文件夹新建文件夹，上传后的文件夹命名为example/folder/，对象存储在名为examplebucket的桶中。 ``` // 引入依赖包 import ObsClient, { PutObjectInput } 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 putObject() { try { const params: PutObjectInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象，此处以 example/folder/ 为例 Key: "example/folder/", }; // 上传对象 const result = await obsClient.putObject(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "Put object(%s) under the bucket(%s) successful!!", params.Key, params.Bucket); hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); hilog.info(0x0001, 'OBS-Harmony', "StorageClass:%s, ETag:%s", result.InterfaceResult.StorageClass, result.InterfaceResult.ETag); 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); return; } catch (error) { const err = error as BusinessError; hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message); } } putObject(); ``` #### 相关链接 - 关于上传对象-PUT上传的API说明，请参见[PUT上传](https://support.huaweicloud.com/api-obs/obs_04_0080.html)。 - 上传对象过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 上传对象常见问题请参见[上传对象失败](https://support.huaweicloud.com/obs_faq/obs_faq_0134.html)。