
# 设置对象标签
#### 功能说明
用户可以通过本接口设置或更新对象（Object）的标签信息。对象标签使用一组键值对（Key-Value）标记对象。
如果请求中不携带版本号（versionId），需要确保执行者有PutObjectTagging权限。如果请求中携带版本号（versionId），需要确保执行者有PutObjectTagging和PutObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作，也可以通过设置桶策略或用户策略给其他用户。
默认设置Object当前版本的标签信息。可以通过指定versionId参数来设置指定Object版本的标签信息。如果对应版本为删除标记（Delete Marker），则OBS将返回404 Not Found。
#### 接口约束
- 您必须是桶拥有者或拥有设置对象标签的权限，才能设置对象标签。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObjectTagging(未开启多版本)、obs:object:PutObjectVersionTagging（开启或暂停多版本）权限，如果使用桶策略则需授予obs:object:PutObjectTagging(未开启多版本)、obs:object: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_0075.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
- 文件桶不支持该功能。
- 每个对象最多能设置10个标签。
 
#### 方法定义
```
ObsClient.setObjectTagging(params)
```
#### 请求参数说明
表1请求参数列表 
| **参数名称**  | **参数类型** | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| 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的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| VersionId | String   | 可选       | **参数解释：** 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 **取值范围：** 长度为32的字符串。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Tags      | Array    | 必选       | **参数解释：** 标签列表。示例：\[{ Key: 'key1', Value: 'value1' }, { Key: 'key2', Value: 'value2' }\]。 **约束限制：** - 标签的键值约束： 键名（Key）区分大小写且必须唯一，不能为空且不能超过128个字符，不允许使用,/\|\<\>=\*\\字符。 键值（Value）区分大小写且可以为空，不能超过255个字符，不允许使用,/\|\<\>=\*\\字符。    **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
#### 返回结果说明
表2ICommonMsg 
| **参数名称**  | **参数类型** |                                                                                                                                                                                                                                 **描述**                                                                                                                                                                                                                                 |
|---|---|---|
| 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服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                                                  |
   
#### 代码示例
本示例用于设置objectname对象的标签。
```
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 前端本身没有process对象，可以使用webpack类打包工具定义环境变量，就可以在代码中运行了。
// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
const AK = process.env.AccessKeyID
const SK = process.env.SecretAccessKey
// 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
const security_token= process.env.SecurityToken
//  server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
const server = "https://obs.cn-north-4.myhuaweicloud.com"
// 创建ObsClient实例
var obsClient = new ObsClient({
    access_key_id: AK,
    secret_access_key: SK,
    server: server
});
async function setObjectTagging() {
    try {
        const params = {
            Bucket: 'examplebucket',
            Key: 'objectname',
            // 多版本场景下指定某一个版本
            // VersionId: '',
            // 对象标签列表
            Tags: [
                { Key: 'key1', Value: 'value1' },
                { Key: 'key2', Value: 'value2' }
            ]
        };
        // 设置对象标签
        const result = await obsClient.setObjectTagging(params);
        if (result.CommonMsg.Status < 300) {
            console.log("Set object(%s)'s tagging successful!", params.Key);
            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()
```
