# 设置对象元数据(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)中发帖求助。 #### 功能说明 元数据（Metadata）为描述对象属性的信息，是一组名称值对，用作对象管理的一部分。 当前支持系统定义的元数据和自定义元数据。 系统定义的元数据又分为两种类别：系统控制和用户控制。如Last-Modified日期等数据由系统控制，不可修改；如为对象配置的ContentLanguage，用户可以通过接口进行修改。 可以通过本接口添加、修改或删除桶中已经上传的对象的元数据。 #### 接口约束 - 您必须是桶拥有者或拥有设置对象元数据的权限，才能设置对象元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ModifyObjectMetaData权限，如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见[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)。 - 当桶开启多版本控制时，最新版本的对象支持设置元数据，历史版本的对象不支持设置元数据。 - 对于存储类别为归档或深度归档存储的对象，不能对其设置对象的元数据。 #### 方法定义 ``` ObsClient.setObjectMetadata(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的字符串。 **默认取值：** 无 | | MetadataDirective | [MetadataDirectiveType] | 必选 | **参数解释：** 复制源对象属性的策略。 **约束限制：** 无 **取值范围：** 可选择的对象属性选项参见[MetadataDirectiveType]。 **默认取值：** 无 | | VersionId | string | 可选 | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | CacheControl | string | 可选 | **参数解释：** 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Cache-Control的取值。 **默认取值：** 无 | | ContentDisposition | string | 可选 | **参数解释：** 响应中的Content-Disposition头。指定对象被下载时的名称。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Disposition的取值。 **默认取值：** 无 | | ContentEncoding | string | 可选 | **参数解释：** 响应中的Content-Encoding头。指定对象被下载时的内容编码格式。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Encoding的取值。 **默认取值：** 无 | | ContentLanguage | string | 可选 | **参数解释：** 响应中的Content-Language头。指定对象被下载时的内容语言格式。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Content-Language的取值。 **默认取值：** 无 | | ContentType | string | 可选 | **参数解释：** 响应中的Content-Type头。指定对象被下载时的文件类型。 **约束限制：** 无 **取值范围：** 常见的Content-Type（MIME）列表参见[如何理解Content-Type（MIME）(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1716.html) **默认取值：** 无 | | Expires | string | 可选 | **参数解释：** 响应中的Expires头。指定对象被下载时的网页的缓存过期时间。 **约束限制：** 无 **取值范围：** 参见HTTP标准头域Expires的取值。 **默认取值：** 无 | | WebsiteRedirectLocation | string | 可选 | **参数解释：** 当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据"WebsiteRedirectLocation"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 **取值范围：** 无 **默认取值：** 无 | | 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 **取值范围：** 无 **默认取值：** 无 | 表2StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.StorageClassStandard | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | ObsClient.enums.StorageClassWarm | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | ObsClient.enums.StorageClassCold | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | 无 | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景 | #### 返回结果 表3返回结果 | **参数类型** | 描述 | |:---|:---| | [表4] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表4]。 | 表4Response | **参数名称** | **参数类型** | 描述 | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [表6] | **参数解释：** 操作成功后的结果数据，详见[表6]。 **约束限制：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |---|---|---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6SetObjectMetadataOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | MetadataDirective | [MetadataDirectiveType] | **参数解释：** 复制源对象属性的策略。 **取值范围：** 可选择的对象属性选项参见[MetadataDirectiveType]。 | | CacheControl | string | **参数解释：** 响应中的Cache-Control头。指定对象被下载时的网页的缓存行为。 | | ContentDisposition | string | **参数解释：** 响应中的Content-Disposition头。指定对象被下载时的名称。 | | ContentEncoding | string | **参数解释：** 响应中的Content-Encoding头。指定对象被下载时的内容编码格式。 | | ContentLanguage | string | **参数解释：** 响应中的Content-Language头。指定对象被下载时的内容语言格式。 | | ContentType | string | **参数解释：** 响应中的Content-Type头。指定对象被下载时的文件类型。 | | Expires | string | **参数解释：** 响应中的Expires头。指定对象被下载时的网页的缓存过期时间。 | | WebsiteRedirectLocation | string | **参数解释：** 当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据"WebsiteRedirectLocation"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 | | 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 | 表7MetadataDirectiveType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.CopyMetadata | COPY | 复制对象时，复制源对象属性。 须知： 该值仅在[复制对象(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0608.html)接口中使用 | | ObsClient.enums.ReplaceMetadata | REPLACE | 使用当前请求中携带的头域完整替换，未指定的元数据会被删除。 | | ObsClient.enums.ReplaceNewMetadata | REPLACE_NEW | 对于已经存在值的元数据进行替换，不存在值的元数据进行赋值，未指定的元数据保持不变。 须知： 该值仅在[设置对象元数据(Node.js SDK)](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_0406.html)接口中使用 | 表8StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | ObsClient.enums.StorageClassStandard | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | ObsClient.enums.StorageClassWarm | WARM | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | ObsClient.enums.StorageClassCold | COLD | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | 无 | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景 | #### 代码示例 本示例用于设置examplebucket桶中的example/objectname对象元数据，并且将对象MIME类型设置成image/jpeg，对象存储类型指定为归档存储，并设置自定义元数据。 ``` // 引入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 setObjectMetadata() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象名，此处以 example/objectname 为例 Key: "example/objectname", // 指定对象MIME类型，这里以image/jpeg为例 ContentType: "image/jpeg", // 指定对象存储类型，这里以 obsClient.enums.StorageClassCold 为例 StorageClass: obsClient.enums.StorageClassCold, // 指定自定义元数据 Metadata: { "property1": "property-value1", "property2": "property-value2" } }; // 设置对象元数据 const result = await obsClient.setObjectMetadata(params); if (result.CommonMsg.Status <= 300) { console.log("Set Object(%s)'s metadata successful with bucket(%s)!", params.Key, 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); }; }; setObjectMetadata(); ```