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

public Guzzle\Service\Resource\Model PutBucketTagging(array $args = array());

Sample request

try {
    $result = $cosClient->putBucketTagging(array(
        'Bucket' => 'examplebucket-1250000000', // Format: BucketName-APPID
        'TagSet' => array(
            array('Key'=>'key1',
                  'Value'=>'value1',
            ),  
            array('Key'=>'key2',
                  'Value'=>'value2',
            ),  
        ),  
    ));
    // Request succeeded
    print_r($result);
} catch (\Exception $e) {
    // Request failed
    echo "$e\n";
}

Parameter description

Querying Bucket Tag

Feature description

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

Method prototype

public Guzzle\Service\Resource\Model GetBucketTagging(array $args = array());

Sample request

try {
    $result = $cosClient->getBucketTagging(array(
        'Bucket' => 'examplebucket-1250000000', // Format: BucketName-APPID
    ));
    // Request succeeded
    print_r($result);
} catch (\Exception $e) {
    // Request failed
    echo($e);
}

Parameter description

Sample return result

GuzzleHttp\Command\Result Object
(
    [TagSet] => Array
        (
            [0] => Array
                (
                    [Key] => key1
                    [Value] => value1
                )

            [1] => Array
                (
                    [Key] => key2
                    [Value] => value2
                )

        )
    [RequestId] => NWRmMWVkMjFfMjJiMjU4NjRfNWQ3X2EwMWVj****
)

Returned result description

Deleting Bucket Tag

Feature description

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

Method prototype

public Guzzle\Service\Resource\Model DeleteBucketTagging(array $args = array());

Sample request

try {
    $result = $cosClient->deleteBucketTagging(array(
        'Bucket' => 'examplebucket-1250000000', // Format: BucketName-APPID
    );
    // Request succeeded
    print_r($result);
} catch (\Exception $e) {
    // Request failed
    echo($e);
}

Parameter description