Obtaining Object Tags

Function

This API is used to obtain the tags of an object. For more information about object tags, see Adding Tags to an Object.

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

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

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 have required permissions. Such permissions can be granted using bucket policies. By default, only the object owner can read or write the object's tags.
• During cross-region replication, tags of source objects are not copied.
• Tags cannot be added to files in parallel file systems.

• 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

obsClient.getObjectTagging(ObjectTaggingRequest request)

Request Parameters

Responses

Sample Code

This example obtains the tags of object objectname in bucket examplebucket.

import android.util.Log;

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;

import java.util.List;

public class GetObjectTaggingDemo {
    private static final String TAG = "GetObjectTaggingDemo";

    public void getObjectTagging() {
       // Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK and store them in the configuration file or environment variables. In this example, the AK and SK are stored in environment variables for identity authentication. Before running the code in this example, configure environment variables ACCESS_KEY_ID and SECRET_ACCESS_KEY_ID.
        // 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 not advised to use hard coding, which may result in information leakage.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://your-endpoint";

        // Create an ObsClient instance.
        ObsClient obsClient = new ObsClient(ak, sk, endPoint);

        try {
            // Obtain object tags.
            String bucketName = "examplebucket";
            String objectKey = "objectname";
            String objectVersionId = "";
            ObjectTaggingRequest objectTaggingRequest =
                    new ObjectTaggingRequest(bucketName, objectKey, objectVersionId, null);
            ObjectTagResult objectTagResult = obsClient.getObjectTagging(objectTaggingRequest);
            Log.i(TAG, "tags of " + objectKey + ":");
            List<TagSet.Tag> tags = objectTagResult.getTagSet().getTags();
            for (TagSet.Tag tag : tags) {
                Log.i(TAG, "tag key:" + tag.getKey() + ", tag value:" + tag.getValue());
            }
            Log.i(TAG, "GetObjectTagging successfully");
        } catch (ObsException e) {
            Log.e(TAG, "GetObjectTagging failed");
            // Request failed. Print the HTTP status code.
            Log.e(TAG, "HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            Log.e(TAG, "Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            Log.e(TAG, "Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            Log.e(TAG, "Request ID:" + e.getErrorRequestId());
            Log.e(TAG, "Host ID:" + e.getErrorHostId());
        } catch (Exception e) {
            Log.e(TAG, "GetObjectTagging failed");
            // Print other error information.
            Log.e(TAG, e.getMessage());
        }
    }
}