Setting Object Tags (SDK for Go)

Function

This API sets or updates tags for an object. Each tag is a key-value pair.

Restrictions

To add tags to an object, you must be the object owner or have the required permission (obs:object:PutObjectTagging in IAM or PutObjectTagging 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.
A bucket can have a maximum of 10 tags.
Tags cannot be set for files in parallel file systems.
A tag key and its value can contain a maximum of 128 and 255 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).

Method

func (obsClient ObsClient) SetObjectTagging(input *Table 2) (output *BaseModel, err error)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
input	*Table 2	Yes	Explanation: Request parameters for adding tags to an object. For details, see Table 2.

**Table 2** SetObjectTaggingInput
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
Key	string	Yes	Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None
VersionId	string	No	Explanation: ID of the object version to be deleted, for example, G001117FCE89978B0000401205D5DC9 Value range: The value must contain 32 characters. Default value: None. If this parameter is left blank, the latest version of the object is deleted.
Tags	[]Tag	Yes	Explanation: Object tag list. For details, see Table 3. Restrictions: An object can have a maximum of 10 tags by default. Each tag has only one key and one value. For the same object, 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 key must contain 1 to 128 characters. Tag keys cannot start or end with a space and cannot contain commas (,), asterisks (), vertical bars (\|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or ASCII control characters (0x00 to 0x1F). Tag keys and values must be URL encoded before being sent to a server. 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 255 characters. Tag values cannot start or end with a space and cannot contain commas (,), asterisks (), vertical bars (\|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or ASCII control characters (0x00 to 0x1F). Tag keys and values must be URL encoded before being sent to a server. 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 Restrictions: None 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 Restrictions: None Value range: None Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers Restrictions: None Value range: None Default value: None

Code Examples

This example adds tags to object example/objectname in bucket examplebucket.

     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 the 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 not advised to use hard coding, which may result in information leakage. 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.SetObjectTaggingInput{}
    // Specify a bucket name.
    input.Bucket = "bucketname"
    // Specify an object (example/objectname as an example).
    input.Key = "example/objectname"
    // Specify tags for the object.
    input.Tags = []obs.Tag{
        {Key: "key0", Value: "value0"},
        {Key: "key1", Value: "value1"},
    }
    // Add tags to the object.
    output, err := obsClient.SetObjectTagging(input)
    if err == nil {
        fmt.Printf("Set object(%s)'s tag configuration with bucket(%s) successful!\n", input.Key, input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Set object(%s)'s tag configuration with bucket(%s) fail!\n", input.Key, 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)
    }
}
 
 
  

Helpful Links

Parent topic: Object Tags (SDK for Go)

Previous topic: Object Tags (SDK for Go)

Next topic: Obtaining Object Tags (SDK for Go)