tencent cloud

Feedback

Bucket Tagging

Last updated: 2022-01-24 12:21:37

    Overview

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

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

    Setting Bucket Tags

    Description

    This API is used to set tags for an existing bucket.

    Method prototype

    func (s *BucketService) PutTagging(ctx context.Context, opt *BucketPutTaggingOptions) (*Response, error)
    

    Sample request

    package main
    import (
       "context"
       "github.com/tencentyun/cos-go-sdk-v5"
       "net/http"
       "net/url"
       "os"
    )
    func main() {
       // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
       // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, see https://www.tencentcloud.com/document/product/436/6224.
       u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
       b := &cos.BaseURL{BucketURL: u}
       client := cos.NewClient(b, &http.Client{
           Transport: &cos.AuthorizationTransport{
               // Get the key from environment variables
               // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
               SecretID: os.Getenv("SECRETID"),
               // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
               SecretKey: os.Getenv("SECRETKEY"),
           },
       })
       opt := &cos.BucketPutTaggingOptions{
           TagSet: []cos.BucketTaggingTag{
               {
                   Key:   "testk1",
                   Value: "testv1",
               },
               {
                   Key:   "testk2",
                   Value: "testv2",
               },
           },
       }
       _, err := client.Bucket.PutTagging(context.Background(), opt)
       if err != nil {
           // ERROR
       }
    }
    

    Parameter description

    type BucketTaggingTag struct {
      Key   string
      Value string
    }
    type BucketPutTaggingOptions struct {
      XMLName xml.Name           
      TagSet  []BucketTaggingTag 
    }
    
    Parameter Description Type
    BucketPutTaggingOptions Bucket tag configuration parameters Struct
    TagSet Bucket tag configuration Struct
    key Tag key. A tag key must not exceed 128 characters and can contain English letters, numbers, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes. String
    value Tag value. A tag value must not exceed 256 characters and can contain English letters, numbers, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes. String

    Querying Bucket Tags

    Description

    This API is used to query the existing tags of a specified bucket.

    Method prototype

    func (s *BucketService) GetTagging(ctx context.Context) (*BucketGetTaggingResult, *Response, error)
    

    Sample request

    package main
    import (
       "context"
       "fmt"
       "github.com/tencentyun/cos-go-sdk-v5"
       "net/http"
       "net/url"
       "os"
    )
    func main() {
       // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
       // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, see https://www.tencentcloud.com/document/product/436/6224.
       u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
       b := &cos.BaseURL{BucketURL: u}
       client := cos.NewClient(b, &http.Client{
           Transport: &cos.AuthorizationTransport{
               // Get the key from environment variables
               // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
               SecretID: os.Getenv("SECRETID"),
               // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
               SecretKey: os.Getenv("SECRETKEY"),
           },
       })
       v, _, err := client.Bucket.GetTagging(context.Background())
       if err != nil {
           fmt.Println(err)
       }
       fmt.Println(v)
    }
    

    Response description

    type BucketTaggingTag struct {
      Key   string
      Value string
    }
    type BucketGetTaggingResult struct {
      XMLName xml.Name           
      TagSet  []BucketTaggingTag 
    }
    
    Parameter Description Type
    BucketGetTaggingResult Bucket tag configuration parameters Struct
    TagSet Bucket tag configuration Struct
    key Tag key. A tag key must not exceed 128 characters and can contain English letters, numbers, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes. String
    value Tag value. A tag value must not exceed 256 characters and can contain English letters, numbers, spaces, plus signs, minus signs, underscores, equals signs, dots, colons, and slashes. String

    Deleting Bucket Tags

    Description

    This API is used to delete the existing tags from a bucket.

    Method prototype

    func (s *BucketService) DeleteTagging(ctx context.Context) (*Response, error)
    

    Sample request

    package main
    import (
      "context"
      "fmt"
      "github.com/tencentyun/cos-go-sdk-v5"
      "net/http"
      "net/url"
      "os"
    )
    func main() {
      // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
      // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, see https://www.tencentcloud.com/document/product/436/6224.
      u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
      b := &cos.BaseURL{BucketURL: u}
      client := cos.NewClient(b, &http.Client{
          Transport: &cos.AuthorizationTransport{
              // Get the key from environment variables
              // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
              SecretID: os.Getenv("SECRETID"),
              // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.tencentcloud.com/cam/capi
              SecretKey: os.Getenv("SECRETKEY"),
          },
      })
      resp, err := client.Bucket.DeleteTagging(context.Background())
      if err != nil {
          fmt.Println(err)
      }
      fmt.Println(resp.Header)
    }
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support