设置对象标签

功能说明

用户可以通过本接口设置或更新对象（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权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。
• OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
• 文件桶不支持该功能。
• 每个对象最多能设置10个标签。

方法定义

ObsClient.setObjectTagging(params)

请求参数说明

返回结果说明

代码示例

本示例用于设置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()