PrevNext
search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Bucket tag

    Last updated: 2020-12-07 14:51:11
    Download PDF

      Overview

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

      API Operation Name Operation Description
      PUT Bucket tagging Setting a bucket tag Sets a tag for an existing bucket
      GET Bucket tagging Querying bucket tags Queries the existing tags of a specified bucket
      DELETE Bucket tagging Deleting a bucket tag Deletes a specified bucket tag

      Setting Bucket Tag

      Feature description

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

      Method prototype

      put_bucket_tagging(Bucket, Tagging={}, **kwargs)

      Sample request

      response = client.put_bucket_tagging(
    Bucket='examplebucket-1250000000',
    Tagging={
        'TagSet': {
            'Tag': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
    }
)

      Parameter description

      Parameter Name Description Type Required
      Bucket Bucket for which to set a tag in the format of BucketName-APPID. For more information, please see Naming Convention String Yes
      Tag Tag set List Yes
      Key Tag key, which can contain letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots, colons, and slashes with a maximum length of 128 bytes String Yes
      Value Tag value, which can contain letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots, colons, and slashes with a maximum length of 256 bytes String Yes

      Returned result description

      The returned value of this method is None.

      Querying Bucket Tag

      Feature description

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

      Method prototype

      get_bucket_tagging(Bucket, **kwargs)

      Sample request

      response = client.get_bucket_tagging(
    Bucket='examplebucket-1250000000'
)

      Parameter description

      Parameter Name Description Type Required
      Bucket Bucket for which to query a tag in the format of BucketName-APPID. For more information, please see Naming Convention String Yes

      Returned result description

      Tag management list of bucket in dict type.

      {
    'TagSet': {
        'Tag': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}
      Parameter Name Description Type
      Tag Tag set List
      Key Tag key, which can contain letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots, colons, and slashes with a maximum length of 128 bytes String
      Value Tag value, which can contain letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots, colons, and slashes with a maximum length of 256 bytes String

      Deleting Bucket Tag

      Feature description

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

      Method prototype

      delete_bucket_tagging(Bucket, **kwargs)

      Sample request

      response = client.delete_bucket_tagging(
    Bucket='examplebucket-1250000000'
)

      Parameter description

      Parameter Name Description Type Required
      Bucket Bucket for which to delete a tag in the format of BucketName-APPID. For more information, please see Naming Convention String Yes

      Returned result description

      The returned value of this method is None.

      tencent
      Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy