After you configure tags for an object, you can query the tags of the object. If versioning is enabled for a bucket that contains the object you want to query, Object Storage Service (OSS) returns the tags of the current version of the object by default. To query the tags of a specified version of the object, you must specify the version ID of the object.

Note
  • Object tagging uses a key-value pair to identify objects. For more information about object tagging, see Configure object tagging in OSS Developer Guide.
  • For more information about how to query the tags of an object, see GetObjectTagging.

Query the tags of an object

If versioning is not enabled for the bucket that contains the object you want to query, you can query the tags of the object based on your requirements. If versioning is enabled for the bucket that contains the object you want to query, OSS returns the tags of the current version of the object by default.

The following code provides an example on how to query the tags of the exampleobject.txt object in the exampledir directory of the examplebucket bucket:

// Set yourEndpoint to the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set yourEndpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// Security risks may arise if you use the AccessKey pair of an Alibaba Cloud account to access OSS because the account has permissions on all API operations. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// Specify the name of the bucket. Example: examplebucket. 
String bucketName = "examplebucket";
// Specify the full path of the object. Example: exampledir/exampleobject.txt. The full path of the object cannot contain bucket names. 
String objectName = "exampledir/exampleobject.txt";

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

// Query the tags of the object. 
TagSet tagSet = ossClient.getObjectTagging(bucketName, objectName);
Map<String, String> tags = tagSet.getAllTags();

// View the tags of the object. 
System.out.println("object tagging: "+ tags.toString());

// Shut down the OSSClient instance. 
ossClient.shutdown();

Query the tags of a specified version of an object

If versioning is enabled for the bucket that contains the object you want to query, you can query the tags of a specified version of the object by specifying the version ID of the object.

The following code provides an example on how to query the tags of a specified version of the exampleobject.txt object in the exampledir directory of the examplebucket bucket:

Note For more information about how to query the version ID of an object, see List objects.
// Set yourEndpoint to the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set yourEndpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// Security risks may arise if you use the AccessKey pair of an Alibaba Cloud account to access OSS because the account has permissions on all API operations. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// Specify the name of the bucket. Example: examplebucket. 
String bucketName = "examplebucket";
// Specify the full path of the object. Example: exampledir/exampleobject.txt. The full path of the object cannot contain bucket names. 
String objectName = "exampledir/exampleobject.txt";
// Specify the version ID of the object. Example: CAEQMxiBgICAof2D0BYiIDJhMGE3N2M1YTI1NDQzOGY5NTkyNTI3MGYyMzJm****. 
String versionId = "CAEQMxiBgICAof2D0BYiIDJhMGE3N2M1YTI1NDQzOGY5NTkyNTI3MGYyMzJm****";

// Create an OSSClient instance. 
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

GenericRequest genericRequest = new GenericRequest(bucketName, objectName, versionId);
TagSet tagSet = ossClient.getObjectTagging(genericRequest);

// View the tags of the object. 
System.out.println("object tagging: "+ tagSet.toString());

// Shut down the OSSClient instance. 
ossClient.shutdown();