- API Reference
- APIs
- Operations on Objects
- Obtaining Object Tags
Obtaining Object Tags¶
Functions¶
This operation returns tags of an object.
If you do not specify a version ID in a request, make sure that you have the GetObjectTagging permission. If you do specify a version ID in a request, make sure that you have 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 or 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 you are retrieving tags from is a delete marker, OBS returns 404 Not Found.
Note
Tags are not supported for files in parallel file systems.
Request Syntax¶
GET /objectname?tagging&versionId=versionid HTTP/1.1
Host: bucketname.obs.region.example.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¶
HTTP/1.1 status_code
x-obs-request-id: request id
x-obs-id-2: id
x-obs-version-id: version id
Content-Type: application/xml
Content-Length: length
Date: date
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Tagging xmlns="http://obs.region.example.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 Elements¶
For more information about the object tag elements returned in the response, see Table 3.
Error Responses¶
In addition to common error codes, this API also returns others. Table 1 lists the common errors and possible causes.
Error Code | Description | HTTP Status Code |
---|---|---|
NoSuchTagSet | No tags were configured for the specified object. | 404 |
Sample Request¶
GET /objectname?tagging&versionId=G001018455096CE600005306000000DD HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.region.example.com
Accept: */*
Date: Wed, 27 Jun 2018 13:25:44 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=
Sample Response¶
HTTP/1.1 200 OK
x-obs-request-id: 0002B7532E0000015BEB35330C5884X1
x-obs-id-2: s12w20LYNQqSb7moq4ibgJwmQRSmVQV+rFBqplOGYkXUpXeS/nOmbkyD+E35K79j
x-obs-version-id: G001018455096CE600005306000000DD
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.region.example.com/doc/2015-06-30/">
<TagSet>
<Tag>
<Key>TagName1</Key>
<Value>TageSetVaule1</Value>
</Tag>
</TagSet>
</Tagging>