Obtaining Bucket Tags
Functions
This operation obtains information about tags of a bucket.
To perform this operation, you must have the GetBucketTagging permission. By default, only the bucket owner can obtain the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
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)
Dependencies
obs:bucket:getBucketTagging
Read
bucket *
-
-
-
- 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
1 2 3 4 |
GET /?tagging HTTP/1.1 Host: bucketname.obs.region.myhuaweicloud.com Date: date Authorization: authorization string |
Request Parameters
This request contains no message parameters.
Request Headers
This request uses common headers. For details, see Table 3.
Request Elements
This request involves no elements.
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
The response to the request uses common headers. For details, see Table 1.
Response Elements
This response contains elements to detail bucket tag configuration. Table 1 describes the elements.
|
Header |
Type |
Description |
|---|---|---|
|
Tagging |
XML |
Definition: Parent element of TagSet and Tag. Constraints: None |
|
TagSet |
XML |
Definition: Parent element of Tag. Parent: Tagging Constraints: A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes. |
|
Tag |
XML |
Definition: Information element of Tag Parent: TagSet Constraints: A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes. |
|
Key |
String |
Definition: Name of a tag. Parent: Tag Constraints:
Range: A string between 1 and 36 characters long. Default value: None |
|
Value |
String |
Definition: Tag value. Parent: Tag Constraints:
Range: A string of 0 (included) to 43 (excluded) characters. Default value: None |
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> |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot