Overview

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

Tagging an Object

Description

This API (PUT Object tagging) is used to tag an existing object by adding tag key-value pairs. This can help you group and manage your existing objects. 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

// 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 := c.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 = c.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 (GET Object tagging) 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

name := "example"
res, _, err := c.Object.GetTagging(context.Background(), name)
if err != nil {
   //ERROR
}

Response

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

Deleting Object Tags

Description

This API (DELETE Object tagging) is used to delete the existing tags of an object.

Method prototype

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

Sample request

name := "example"
_, err = c.Object.DeleteTagging(context.Background(), name)
if err != nil {
   //ERROR
}