Configuring Tags for a Bucket (SDK for Python)

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

ObsClient.setBucketTagging(bucketName, tagInfo, extensionHeaders)

Request Parameters

Parameter	Type	Mandatory (Yes/No)	Description
bucketName	str	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 periods (.) and hyphens (-) 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 properties comply with those set in the first creation request. Default value: None
tagInfo	TagInfo	Yes	Explanation: Bucket tag list. For details, see Table 1. 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. Default value: None
extensionHeaders	dict	No	Explanation: Extension headers. Value range: See User-defined Header (SDK for Python). Default value: None

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

str

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 periods (.) and hyphens (-) 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 properties comply with those set in the first creation request.

Default value:

None

tagInfo

TagInfo

Yes

Explanation:

Bucket tag list. For details, see Table 1.

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.

Default value:

None

extensionHeaders

dict

Explanation:

Extension headers.

Value range:

See User-defined Header (SDK for Python).

Default value:

None

**Table 1** TagInfo
Parameter	Type	Mandatory (Yes/No)	Description
tagSet	list of Tag	Yes if used as a request parameter	Explanation: Bucket tag list. For details, see Table 2. 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. Default value: None

**Table 2** Tag
Parameter	Type	Mandatory (Yes/No)	Description
key	str	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	str	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

Type	Description
GetResult	Explanation: SDK common results

Type

Description

GetResult

Explanation:

SDK common results

**Table 3** GetResult
Parameter	Type	Description
status	int	Explanation: HTTP status code Value range: A status code is a group of digits ranging from 2xx (indicating successes) to 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
reason	str	Explanation: Reason description. Default value: None
errorCode	str	Explanation: Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
errorMessage	str	Explanation: Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
requestId	str	Explanation: Request ID returned by the OBS server Default value: None
indicator	str	Explanation: Error indicator returned by the OBS server. Default value: None
hostId	str	Explanation: Requested server ID. If the value of status is less than 300, this parameter is left blank. Default value: None
resource	str	Explanation: Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank. Default value: None
header	list	Explanation: Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header. Default value: None
body	object	Explanation: Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python). Default value: None

Code Examples

This example configures tags for bucket examplebucket.

     
      
        
        
          from obs import ObsClient
from obs import TagInfo
import os
import traceback

# Obtain an AK and SK pair using environment variables or import the AK and SK pair in other ways. Using hard coding may result in leakage.
# Obtain an AK and 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 and SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK and SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    tagInfo = TagInfo()
    # Specify the label content.
    tagInfo.addTag('tag1', 'value1').addTag('tag2', 'value2')
    bucketName="examplebucket"
    # Configure tags for the bucket.
    resp = obsClient.setBucketTagging(bucketName, tagInfo)
    # If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.
    if resp.status < 300:
        print('Set Bucket Tagging Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket Tagging Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Set Bucket Taggingg Failed')
    print(traceback.format_exc())

         

       

     
    