Obtaining Object Tags (SDK for Python)

Function

This API is used to obtain the tags of an object.

If there is no object version ID (indicated by versionId) contained in the request, you must have the GetObjectTagging permission. If there is an object version ID (indicated by versionId) contained in the request, you must have both the GetObjectTagging and GetObjectVersionTagging permissions. By default, only the object owner can perform this operation. The object owner can grant this permission to others by using a bucket policy or a user policy.

OBS returns the tags of the current object version by default. You can use the versionId parameter to retrieve tags of any other version. If the version is a delete marker, OBS returns 404 Not Found.

Restrictions

To obtain the tags of an object, you must be the bucket owner or have the required permissions (obs:object:GetObjectTagging (versioning disabled) and obs:object:GetObjectVersionTagging (versioning enabled or suspended) granted using IAM or obs:object:GetObjectTagging (versioning disabled) and obs:object:GetObjectVersionTagging (versioning enabled or suspended) granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
This API is not available for parallel file systems.

Method

ObsClient.getObjectTagging(bucketName, objectKey, versionId, extensionHeaders)

Request Parameters

**Table 1** List of 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 a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets with 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
objectKey	str	Yes	Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object 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	str	No	Explanation: Object version ID, for example, G001117FCE89978B0000401205D5DC9A Value range: The value must contain 32 characters. Default value: None
extensionHeaders	dict	No	Explanation: Extension headers Value range: See User-defined Headers (SDK for Python). Default value: None

Responses

**Table 2** Responses
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 indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). 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, this parameter is left blank. The value varies with the API being called. For details, see the sections "Bucket-Related APIs" and "Object-Related APIs". Default value: None

**Table 4** GetResult.body
GetResult.body Type	Description
Table 5	Explanation: Object tag. For details, see Table 5.

**Table 5** TagInfoModel
Parameter	Type	Description
tags	list of dict	Explanation: Tag list, for example, [{'key': 'env', 'value': 'prod'}, {'key': 'project', 'value': 'demo'}]

Sample Code

This example obtains tags of object exampleobject in bucket examplebucket.

     from obs import ObsClient
import os
import traceback

# Obtain an AK/SK pair using environment variables (recommended) or import it 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.
# Before running the sample code, ensure that the environment variables AccessKeyID and SecretAccessKey have been configured.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# If you use a temporary AK/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 currently in use.
server = "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, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucket_name = 'examplebucket'
    object_name = 'exampleobject'
    # Obtain object tags.
    resp = obsClient.getObjectTagging(bucket_name, object_name)

    # If status code 2xx is returned, the API call succeeds. Otherwise, the API call fails.
    if resp.status < 300:
        print('Get Object Tagging Succeeded')
        print('requestId:', resp.requestId)
        print('tags:', resp.body.tags)
    else:
        print('Get Object Tagging Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Get Object Tagging Failed')
    print(traceback.format_exc())
 
 
  

Parent topic: Object Tags (SDK for Python)

Previous topic: Adding Tags to an Object (SDK for Python)

Next topic: Deleting Object Tags (SDK for Python)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot