Overview

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

Tagging an Object

Description

This API is used to set tags for an existing object. It can help you group and manage existing object resources by adding key-value pairs as object tags. For more information, please see Object Tagging Overview.

Method prototype

func (s *ObjectService) PutTagging(ctx context.Context, name string, opt *ObjectPutTaggingOptions, id ...string) (*Response, error)

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
   "strings"
)
func main() {
   // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.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.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   // Sample 1. Use PutTagging to tag in-cloud objects
   opt := &cos.ObjectPutTaggingOptions{
       TagSet: []cos.ObjectTaggingTag{
           {
               Key:   "test_k2",
               Value: "test_v2",
           },
           {
               Key:   "test_k3",
               Value: "test_v3",
           },
       },
   }
   name := "example"
   _, err := client.Object.PutTagging(context.Background(), name, opt)
   if err != nil {
       //ERROR
   }    
   // Sample 2. Tag an object when it is uploaded
   name = "test/example"
   f := strings.NewReader("test")
   popt := &cos.ObjectPutOptions{
       ObjectPutHeaderOptions: &cos.ObjectPutHeaderOptions{
           XOptionHeader: &http.Header{},
       },
   }
   popt.XOptionHeader.Add("x-cos-tagging", "Key1=Value1&Key2=Value2")
   _, err = client.Object.Put(context.Background(), name, f, popt)
} 

Parameter description

type ObjectPutTaggingOptions struct {
  TagSet  []ObjectTaggingTag
}
type BucketTaggingTag struct {
  Key   string
  Value string
}

Querying Object Tags

Description

This API is used to query the existing tags of an object.

Method prototype

func (s *ObjectService) GetTagging(ctx context.Context, name string, id ...string) (*ObjectGetTaggingResult, *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.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.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.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   name := "example"
   res, _, err := client.Object.GetTagging(context.Background(), name)
   if err != nil {
       //ERROR
   }
   fmt.Println(res)
}

Response

type ObjectGetTaggingResult struct {
   TagSet  []ObjectTaggingTag
}
type BucketTaggingTag struct {
   Key   string
   Value string
}

Deleting Object Tags

Description

This API is used to delete existing tags of an object.

Method prototype

func (s *ObjectService) DeleteTagging(ctx context.Context, name string, id ...string) (*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.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.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.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   name := "example"
   _, err := client.Object.DeleteTagging(context.Background(), name)
   if err != nil {
       //ERROR
   }
}