Obtaining Bucket Tags

Functions

Tags are used to identify buckets or objects in OBS and help you classify buckets or objects. You can call this API to obtain the tags of a specified bucket. For more information about bucket tags, see Adding Tags to a Bucket.

Authorization Information

To call this API, you must be the bucket owner or have the permission to obtain the tags of a bucket. You are advised to use IAM or bucket policies for authorization. For details about OBS authorization methods, see Differences Between OBS Permissions Control Methods.

• If you use IAM for authorization, you need to use either role/policy-based authorization or identity policy-based authorization and configure the required permissions:
  • If you use role/policy-based authorization (IAM v3 APIs in the old IAM version), you need to grant the obs:bucket:GetBucketTagging permission. For details, see Creating a Custom IAM Policy.
  • If you use identity policy-based authorization (IAM v5 APIs in the new IAM version), you need to grant the obs:bucket:getBucketTagging permission, as shown in the following table. For details, see Creating a Custom IAM Identity Policy.

    Action	Access Level	Resource Type (*: Required)	Condition Key	Alias	Dependencies
    obs:bucket:getBucketTagging	Read	bucket *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-
    		-	obs:EpochTime obs:SourceIp obs:TlsVersion obs:CustomDomain

• If you use bucket policies for authorization, you need to grant the obs:bucket:GetBucketTagging permission. For details, see Creating a Custom Bucket Policy.

Request Syntax

The following is an example request. Replace BucketName with your bucket name and RegionID with the ID of the region where your bucket resides. You can obtain the region ID by referring to Supported Regions.

1
2
3
4

GET /?tagging HTTP/1.1 
Host: BucketName.obs.RegionID.myhuaweicloud.com 
Date: GMT Date
Authorization: SignatureValue

URI Parameters

This request contains no message parameters.

Request Headers

This request uses common headers. For details, see Table 3.

Request Body

This request contains no request body parameters.

Response Syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

HTTP/1.1 status_code
x-obs-request-id: request id
x-obs-id-2: id
Content-Type: application/xml 
Content-Length: length
Date: date
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<Tagging xmlns="http://obs.ap-southeast-1.myhuaweicloud.com/doc/2015-06-30/">
    <TagSet> 
        <Tag> 
            <Key>key</Key> 
            <Value>value</Value> 
        </Tag> 
    </TagSet> 
</Tagging>

Response Headers

This response uses common headers. For details, see Table 1.

Response Body

This response contains elements to detail bucket tag configuration. Table 1 describes the elements.

Error Responses

In addition to common error codes, this API also returns other error codes. The following table lists common errors and possible causes. For details, see Table 2.

Sample Request

1
2
3
4
5
6

GET /?tagging HTTP/1.1   
User-Agent: curl/7.29.0   
Host: examplebucket.obs.region.myhuaweicloud.com
Accept: */*   
Date: Wed, 27 Jun 2018 13:25:44 GMT  
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

HTTP/1.1 200 OK 
x-obs-request-id: 0002B7532E0000015BEB35330C5884X1 
x-obs-id-2: s12w20LYNQqSb7moq4ibgJwmQRSmVQV+rFBqplOGYkXUpXeS/nOmbkyD+E35K79j 
Content-Type: application/xml 
Date: Wed, 27 Jun 2018 13:25:44 GMT 
Content-Length: 441 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Tagging xmlns="http://obs.ap-southeast-1.myhuaweicloud.com/doc/2015-06-30/">
  <TagSet>
    <Tag>
      <Key>TagName1</Key>
      <Value>TagSetValue1</Value>
    </Tag>
  </TagSet>
</Tagging>

Using SDKs to Call APIs

You are advised to use OBS SDKs to call APIs. SDKs encapsulate APIs to simplify development. You can call SDK API functions to access OBS without manually calculating signatures.

References

• For more information about bucket tags, see Adding Tags to a Bucket.
• For details about the billing items involved in API operations, see Billing Items.