# 设置对象标签(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)中发帖求助。 #### 功能介绍 用户可以通过本接口设置或更新对象（Object）的标签信息。对象标签使用一组键值对（Key-Value）标记对象。 #### 接口约束 - 您必须是桶拥有者或拥有设置对象标签的权限，才能设置对象标签。建议使用IAM或桶策略进行授权，如果请求中不携带版本号（versionId），使用IAM则需授予obs:object:PutObjectTagging权限，使用桶策略则需授予PutObjectTagging权限。如果请求中携带版本号（versionId），使用IAM则需额外授予obs:object:PutObjectVersionTagging权限，使用桶策略则需额外授予PutObjectVersionTagging权限。相关授权方式介绍可参见[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_0123.html)。 - 默认设置Object当前版本的标签信息。可以通过指定versionId参数来设置指定Object版本的标签信息。如果对应版本为删除标记（Delete Marker），则OBS将返回404 Not Found。 - 并行文件系统不支持该功能。 - 每个对象最多能设置10个标签。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。 #### 方法定义 ``` ObsClient.setObjectTagging(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的字符串。 **默认取值：** 无 | | VersionId | string | 可选 | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | Tags | [Tag]\[\] | 必选 | **参数解释：** 对象标签列表。 **约束限制：** - 一个桶默认最大拥有10个标签。每个标签有且只有一对键值。 - 同一个桶标签的键不能重复，但是值可以重复，并且可以为空。 **取值范围：** 详见[Tag]。 **默认取值：** 无 | 表2Tag | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | Key | string | 作为请求参数时必选 | **参数解释：** 标签的键。 **约束限制：** - 同一个桶标签的键不能重复。 - 最大长度为36个字符。 - UTF-8格式表示的字母（含中文）、数字、空格，以及以下字符：_ . : = + - @。 - 区分大小写。 - 不能为空。 **取值范围：** 长度为1到36个字符。 **默认取值：** 无 | | Value | string | 作为请求参数时必选 | **参数解释：** 标签的值。 **约束限制：** - 标签的值可以重复。 - 长度范围为0到43个字符。 - UTF-8格式表示的字母（含中文）、数字、空格，以及以下字符：_ . : = + - @。 - 区分大小写。 - 可以为空 **取值范围：** 长度为0到43个字符。 **默认取值：** 无 | #### 返回结果 表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服务端返回的详细错误码。 | 表6BaseResponseOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | #### 代码示例 本示例用于设置名为examplebucket桶下example/objectname的对象标签。 ``` // 引入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 setObjectTagging() { try { const params = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象名，此处以 example/objectname 为例 Key: "example/objectname", // 指定桶的标签 Tags: [ {Key: "key0", Value: "value0"}, {Key: "key1", Value: "value1"}, ] }; // 设置对象标签配置 const result = await obsClient.setObjectTagging(params); if (result.CommonMsg.Status <= 300) { console.log("Set Object(%s)'s tagging configuration successful with Bucket(%s)", 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); }; }; setObjectTagging(); ```