Help Center/ Object Storage Service/ SDK Reference/ Go/ Buckets (SDK for Go)/ Configuring Tags for a Bucket (SDK for Go)
Updated on 2024-09-05 GMT+08:00

Configuring Tags for a Bucket (SDK for Go)

Function

If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analysis. For example, if you have an application that uploads its running data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.

This API adds tags to a bucket.

Restrictions

  • A bucket can have a maximum of 10 tags.
  • A tag key and key value can contain a maximum of 36 and 43 characters, respectively.
  • Tag keys and key values cannot contain commas (,), asterisks (*), vertical bars (|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or ASCII codes (0x00 to 0x1F).
  • To configure tags for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketTagging in IAM or PutBucketTagging in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
  • The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

func (obsClient ObsClient) SetBucketTagging(input *SetBucketTaggingInput) (output *BaseModel, err error)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

input

*SetBucketTaggingInput

Yes

Explanation:

Input parameters for configuring tags for a bucket. For details, see Table 2.

Table 2 SetBucketTaggingInput

Parameter

Type

Mandatory (Yes/No)

Description

Bucket

string

Yes

Explanation:

Bucket name

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

Tags

[]Tag

Yes

Explanation:

Bucket tag list. For details, see Table 3.

Restrictions:

  • A bucket can have a maximum of 10 tags. Each tag can have only one pair of key values.
  • For the same bucket, tag keys must be unique, but tag values can be duplicated or left blank.
Table 3 Tag

Parameter

Type

Mandatory (Yes/No)

Description

Key

string

Yes if used as a request parameter

Explanation:

Tag key

Restrictions:

  • The tag key in the same bucket must be unique.
  • The value of the key can be self-defined or predefined by TMS.
  • The value must contain 1 to 36 characters.
  • The value cannot begin or end with a space, cannot include non-printable ASCII characters (0–31), and the following special characters: *<>\=
  • The value is case-sensitive.

Default value:

None

Value

string

Yes if used as a request parameter

Explanation:

Tag value

Restrictions:

Tag values can be duplicated or left blank.

  • The value must contain 0 to 43 characters.
  • The value cannot include non-printable ASCII characters (0–31), and the following special characters: *<>\=
  • The value is case-sensitive.

Default value:

None

Responses

Table 4 List of returned results

Parameter

Type

Description

output

*BaseModel

type BaseModel struct

Explanation:

Returned results. For details, see Table 5.

err

error

Explanation:

Error messages returned by the API

Table 5 BaseModel

Parameter

Type

Description

StatusCode

int

Explanation:

HTTP status code

Value range:

A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code.

Default value:

None

RequestId

string

Explanation:

Request ID returned by the OBS server

Default value:

None

ResponseHeaders

map[string][]string

Explanation:

HTTP response headers

Default value:

None

Code Examples

This example adds tags for bucket examplebucket.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding to reduce leakage risks. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    // securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.SetBucketTaggingInput{}
    // Specify a bucket name.
    input.Bucket = "bucketname"
    // Specify tags for the bucket.
    input.Tags = []obs.Tag{
        {Key: "key0", Value: "value0"},
        {Key: "key1", Value: "value1"},
    }
    // Configure tags for the bucket.
    output, err := obsClient.SetBucketTagging(input)
    if err == nil {
        fmt.Printf("Set bucket(%s)'s tag configuration successful!\n", input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Set bucket(%s)'s tag configuration fail!\n", input.Bucket)
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}