文档首页/ 对象存储服务 OBS/ SDK参考/ Java/ 管理对象(Java SDK)/ 设置对象标签(Java SDK)
更新时间：2024-11-06 GMT+08:00
查看PDF
分享

设置对象标签(Java SDK)

功能介绍

用户可以通过本接口设置或更新对象（Object）的标签信息。对象标签使用一组键值对（Key-Value）标记对象。

如果请求中不携带版本号（versionId），需要确保执行者有PutObjectTagging权限。如果请求中携带版本号（versionId），需要确保执行者有PutObjectTagging+PutObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作，也可以通过设置桶策略或用户策略给其他用户。

默认设置Object当前版本的标签信息。可以通过指定versionId参数来设置指定Object版本的标签信息。如果对应版本为删除标记（Delete Marker），则OBS将返回404 Not Found。

  • 文件桶不支持该功能
  • 每个对象最多能设置10个标签。
  • 标签的键名（Key）的最大长度为36个字符，不能包含=*<>\，|/，且首尾字符不能为空格，区分大小写，不可重复，不能为空。
  • 标签的键值（Value）的最大长度为43个字符，不能包含=*<>\，|/，且首尾字符不能为空格，区分大小写，可以为空。

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

方法定义

HeaderResponse setObjectTagging(ObjectTaggingRequest request)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

request

ObjectTaggingRequest

必选

参数解释：

设置对象属性请求参数，详见ObjectTaggingRequest。
表2 ObjectTaggingRequest

参数名称

参数类型

是否必选

描述

bucketName

String

是

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

objectKey

String

是

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

versionId

String

否

参数解释：

对象的版本号。

取值范围：

长度为32的字符串。

默认取值：

无

objectTagResult

ObjectTagResult

仅设置标签时必选

记录要设置到对象上的标签
表3 ObjectTagResult

参数名称

参数类型

是否必选

描述

tagSet

TagSet

必选

（作为请求参数时）

参数解释：

对象标签，用以标识哪些对象可以匹配到当前这条规则。详见TagSet。

默认取值：

无

statusCode

int

否

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。

完整的状态码列表请参见状态码。

默认取值：

无

responseHeaders

Map<String, Object>

否

参数解释：

HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。

默认取值：

无
表4 TagSet

参数名称

参数类型

是否必选

描述

tags

List<Tag>

必选

参数解释：

对象标签列表，详见Tag。

返回结果说明

表5 返回结果如下

方法名称

返回值类型

说明

setObjectTagging(ObjectTaggingRequest request)

HeaderResponse

用于设置对象标签。
表6 返回结果HeaderResponse(SDK公共响应结果)各项属性说明

参数名称

参数类型

描述

statusCode

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。

完整的状态码列表请参见状态码。

默认取值：

无

responseHeaders

Map<String, Object>

参数解释：

HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。

默认取值：

无

示例代码

本示例用于为examplebucketname桶中exampleObjectKey对象设置对象标签。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketTagInfo.TagSet;
import com.obs.services.model.ObjectTagResult;
import com.obs.services.model.ObjectTaggingRequest;
public class SetObjectTagging001 {
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT")
        // 创建ObsClient实例
        try (ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint)) {
            // 设置对象标签，请注意，该接口为全量设置接口，设置时注意会覆盖掉该对象之前的所有标签
            String bucketName = "examplebucketname";
            String objectKey = "exampleObjectKey";
            String objectVersionId = "";
            ObjectTagResult objectTagResult = new ObjectTagResult();
            TagSet tagSet = new TagSet();
            tagSet.addTag("tagKey1", "tagVal1");
            tagSet.addTag("tagKey2", "tagVal2");
            objectTagResult.setTagSet(tagSet);
            ObjectTaggingRequest objectTaggingRequest =
                    new ObjectTaggingRequest(bucketName, objectKey, objectVersionId, objectTagResult);
            obsClient.setObjectTagging(objectTaggingRequest);
            System.out.println("SetObjectTagging successfully");
        } catch (ObsException e) {
            System.out.println("SetObjectTagging failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("SetObjectTagging failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

父主题： 管理对象(Java SDK)

相关文档