# 设置对象标签(Java SDK) #### 功能介绍 用户可以通过本接口设置或更新对象标签。对象标签使用一组键值对（Key-Value）标记对象。 如果请求中不携带版本号（versionId），需要确保执行者有PutObjectTagging权限。如果请求中携带版本号（versionId），需要确保执行者有PutObjectTagging+PutObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作，也可以通过设置桶策略或用户策略给其他用户。 默认设置Object当前版本的标签信息。可以通过指定versionId参数来设置指定Object版本的标签信息。如果对应版本为删除标记（Delete Marker），则OBS将返回404 Not Found。 OBS支持使用对象标签对桶中的对象进行分类，调用本接口可为已有对象添加或更新标签。了解更多对象标签相关信息，请参考[对象标签](https://support.huaweicloud.com/usermanual-obs/obs_41_0054.html)。 #### 接口约束 - 对象标签功能目前在公测阶段，免费使用；公测结束后，将收取费用。 - 用户读写对象标签必须拥有对应标签操作权限，当前可通过设置桶策略授权给其他用户。默认情况下只有对象的所有者可以执行此操作。 - 用户可在PUT上传、分段上传、上传、复制对象过程中设置标签，也可以对已上传的对象设置标签。 - 设置或更改对象标签不会改变对象的Lastmodified时间。 - 暂不支持CRR，即跨区域复制时，源对象标签不会被复制到目标桶。 - 并行文件系统不支持给文件添加标签。 - 每个对象最多能设置10个标签。 - 标签的键值约束： 键名（Key）区分大小写且必须唯一，不能为空且不能超过128个字符，不允许使用,/\|\<\>=\*\\字符。 键值（Value）区分大小写且可以为空，不能超过255个字符，不允许使用,/\|\<\>=\*\\字符。 #### 方法定义 obsClient.setObjectTagging(ObjectTaggingRequest request) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request | [ObjectTaggingRequest] | 必选 | **参数解释** **：** 设置对象标签请求参数，详见[ObjectTaggingRequest]。 | 表2ObjectTaggingRequest | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | 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] | 仅设置标签时必选 | **参数解释：** 记录要设置到对象上的标签。 **取值范围：** [ObjectTagResult]。 | 表3ObjectTagResult | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | tagSet | [TagSet] | 必选 （作为请求参数时） | **参数解释：** 对象标签，用于标识对象。详见[TagSet]。 **默认取值：** 无 | | statusCode | int | 否 | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | 否 | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | 表4TagSet | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | tags | List\<[Tag]\> | 必选 | **参数解释：** 对象标签列表，详见[Tag]。 | 表5Tag | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | key | String | 必选 | **参数解释：** 标签的名字。 **约束限制：** - 不能为空，不能包含非打印字ASCII（0-31）、"="、"\*"、"\<"、"\>"、"\\"。 - 同一个桶，Tag中的key不能重复。 - 最长为36个字符。 **默认取值：** 无 | | value | String | 必选 | **参数解释：** 标签的值。 **约束限制：** - 可以为空，不为空时不能包含非打印字ASCII（0-31）、"="、"\*"、"\<"、"\>"、"\\"。 - 最长为43个字符。 **默认取值：** 无 | #### 返回结果说明 表6返回结果如下 | **方法名称** | **返回值类型** | **说明** | |:---|:---|:---| | setObjectTagging(ObjectTaggingRequest request) | [HeaderResponse] | 用于设置对象标签。 | 表7返回结果HeaderResponse(SDK公共响应结果)各项属性说明 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | statusCode | int | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | responseHeaders | Map\ | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无 | #### 示例代码 本示例用于为examplebucketname桶中exampleObjectKey对象设置对象标签。 ``` 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, 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(); } } } ```