Help Center/ Object Storage Service/ SDK Reference/ Java/ Object APIs (SDK for Java)/ Object Tags (SDK for Java)/ Setting Object Tags (SDK for Java)
Updated on 2026-08-14 GMT+08:00
View PDF
Share

Setting Object Tags (SDK for Java)

Function

This API is used to add tags to or update tags of an object. An object tag is a key-value pair.

If there is no object version ID (indicated by versionId) contained in the request, you must have the PutObjectTagging permission. If you specify a version ID in a request, make sure that you have the PutObjectTagging and PutObjectVersionTagging permissions. By default, only the object owner can perform this operation. The object owner can grant this permission to others by using a bucket policy or a user policy.

Tags are added to the current version of an object by default. You can use the versionId parameter to add tags to any other version. If the version is a delete marker, OBS returns 404 Not Found.

OBS allows you to use object tags to classify objects in a bucket. You can call this API to add or update tags for an existing object. For more information about object tags, see Adding Tags to an Object.

If you have any questions during development, post them on the Issues page of GitHub.

Restrictions

  • Object tags are now in open beta testing, and you can use them for free. Once the testing period is over, you will be billed for using object tags.
  • To read or write object tags, you must be the object owner or have required permissions. Such permissions can be granted using bucket policies.
  • During cross-region replication, tags of source objects are not copied.
  • Tags cannot be added to files in parallel file systems.
  • Currently, object tags cannot be used in IAM permissions or bucket policies.
  • An object can have up to 10 tags.
  • Constraints on the tag key and value:

    A tag key is case sensitive and must be unique. It cannot be left blank or exceed 128 characters. The following characters are not allowed: ,/|<>=*\

    A tag value is case sensitive and can be left blank. It cannot exceed 255 characters. The following characters are not allowed: ,/|<>=*\

Method

HeaderResponse setObjectTagging(ObjectTaggingRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

ObjectTaggingRequest

Yes

Explanation:

Request parameters for setting object tags. For details, see Table 2.
Table 2 ObjectTaggingRequest

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

String

Yes

Explanation:

Bucket name.

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

objectKey

String

Yes

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name.

For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

versionId

String

No

Explanation:

Object version ID.

Value range:

The value must contain 32 characters.

Default value:

None

objectTagResult

ObjectTagResult

Yes when setting tags

Tags to be set on the object.
Table 3 ObjectTagResult

Parameter

Type

Mandatory (Yes/No)

Description

tagSet

TagSet

Yes

(when used as a request parameter)

Explanation:

Object tags that identify the objects the rule applies to. For details, see Table 4.

Default value:

None

statusCode

int

No

Explanation:

HTTP status code.

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors).

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

No

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None
Table 4 TagSet

Parameter

Type

Mandatory (Yes/No)

Description

tags

List<Tag>

Yes

Explanation:

Object tag list. For details, see Table 5.
Table 5 Tag

Parameter

Type

Mandatory (Yes/No)

Description

key

String

Yes

Explanation:

Name of a tag.

Restrictions:

  • This parameter must not be left blank or contain unprintable ASCII characters (0–31) or the following special characters: *<>\=
  • The tag keys in the same bucket must be unique.
  • The value can be up to 36 characters long.

Default value:

None

value

String

Yes

Explanation:

Tag value.

Restrictions:

  • This parameter can be left blank, but if specified, cannot include unprintable ASCII characters (0–31) and the following special characters: *<>\=
  • The value can be up to 43 characters long.

Default value:

None

Responses

Table 6 Response headers

Method

Return Value Type

Description

setObjectTagging(ObjectTaggingRequest request)

HeaderResponse

Results returned for the request to set object tags.
Table 7 Common response headers

Parameter

Type

Description

statusCode

int

Explanation:

HTTP status code.

Value range:

A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response.

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None

Code Examples

This example sets tags for object exampleObjectKey in bucket examplebucketname.

 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) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        //String endPoint = System.getenv("ENDPOINT")
        // Create an ObsClient instance.
        try (ObsClient obsClient = new ObsClient(ak, sk, endPoint)) {
            // Set object tags. Note that new tags set will overwrite all existing tags.
            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");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request 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");
            // Print other error information.
            e.printStackTrace();
        }
    }
}