Overview

This document provides an overview of APIs and SDK code samples related to bucket tagging.

Setting Bucket Tag

Feature description

This API (PUT Bucket tagging) is used to set a tag for an existing bucket.

Method prototype

PutBucketTaggingResult putBucketTagging(PutBucketTaggingRequest request)throws CosXmlClientException, CosXmlServiceException;

void putBucketTaggingAsync(PutBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
PutBucketTaggingRequest putBucketTaggingRequest = new PutBucketTaggingRequest(bucket);
putBucketTaggingRequest.addTag("key", "value");
putBucketTaggingRequest.addTag("hello", "world");

// Use the sync method
try {
    PutBucketTaggingResult putBucketTaggingResult = cosXmlService.putBucketTagging(putBucketTaggingRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.putBucketTaggingAsync(putBucketTaggingRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        PutBucketTaggingResult putBucketTaggingResult = (PutBucketTaggingResult) result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description

Querying Bucket Tag

Feature description

This API (GET Bucket tagging) is used to query the existing tags of a specified bucket.

Method prototype

GetBucketTaggingResult getBucketTagging(GetBucketTaggingRequest request)throws CosXmlClientException, CosXmlServiceException;

void getBucketTaggingAsync(GetBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketTaggingRequest getBucketTaggingRequest = new GetBucketTaggingRequest(bucket);
// Set signature verification host. All headers are to be verified by default
Set<String> headerKeys = new HashSet<>();
headerKeys.add("Host");
getBucketTaggingRequest.setSignParamsAndHeaders(null, headerKeys);
// Use the sync method
try {
    GetBucketTaggingResult getBucketTaggingResult = cosXmlService.getBucketTagging(getBucketTaggingRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.getBucketTaggingAsync(getBucketTaggingRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        GetBucketTaggingResult getBucketTaggingResult = (GetBucketTaggingResult)result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description

Deleting Bucket Tag

Feature description

This API (DELETE Bucket tagging) is used to delete an existing tag of a specified bucket.

Method prototype

DeleteBucketTaggingResult deleteBucketTagging(DeleteBucketTaggingRequest request)throws CosXmlClientException, CosXmlServiceException;

void deleteBucketTaggingAsync(DeleteBucketTaggingRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
DeleteBucketTaggingRequest deleteBucketTaggingRequest = new DeleteBucketTaggingRequest(bucket);
// Set signature verification host. All headers are to be verified by default
Set<String> headerKeys = new HashSet<>();
headerKeys.add("Host");
deleteBucketTaggingRequest.setSignParamsAndHeaders(null, headerKeys);
// Use the sync method
try {
    DeleteBucketTaggingResult deleteBucketTaggingResult = cosXmlService.deleteBucketTagging(deleteBucketTaggingRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.deleteBucketTaggingAsync(deleteBucketTaggingRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        DeleteBucketTaggingResult getBucketTaggingResult = (DeleteBucketTaggingResult)result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {

    }
});

Parameter description

Response description