vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/en-us_topic_0000001399487626.html
zhangyue 7d2a7ec198 OBS API DOC 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-11-05 16:37:11 +00:00

142 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001399487626"></a><a name="EN-US_TOPIC_0000001399487626"></a>
<h1 class="topictitle1">Obtaining Object Tags</h1>
<div id="body0000001399487626"><div class="section" id="EN-US_TOPIC_0000001399487626__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="EN-US_TOPIC_0000001399487626__p328123010563">This operation returns tags of an object.</p>
<p id="EN-US_TOPIC_0000001399487626__p028114308563">If you do not specify a version ID in a request, make sure that you have the <strong id="EN-US_TOPIC_0000001399487626__b17493114614616">GetObjectTagging</strong> permission. If you do specify a version ID in a request, make sure that you have the <strong id="EN-US_TOPIC_0000001399487626__b138212146714">GetObjectTagging</strong> and <strong id="EN-US_TOPIC_0000001399487626__b13821014576">GetObjectVersionTagging</strong> 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.</p>
<p id="EN-US_TOPIC_0000001399487626__p57251938173210">OBS returns the tags of the current object version by default. You can use the <strong id="EN-US_TOPIC_0000001399487626__b66331141445">versionId</strong> parameter to retrieve tags of any other version. If the version you are retrieving tags from is a delete marker, OBS returns <strong id="EN-US_TOPIC_0000001399487626__b19589165814815">404 Not Found</strong>.</p>
</div>
<div class="note" id="EN-US_TOPIC_0000001399487626__note18725120448"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001399487626__p10725520443">Tags are not supported for files in parallel file systems.</p>
</div></div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section760823317564"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001399487626__screen19232727152544"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/objectname?tagging<span class="err">&amp;</span>versionId=versionid<span class="w"> </span>HTTP/1.1
Host:<span class="w"> </span>bucketname.obs.region.example.com
Date:<span class="w"> </span>date<span class="w"> </span>
Authorization:<span class="w"> </span>authorization<span class="w"> </span>string
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section1371325895711"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001399487626__p1815191317587">This request contains no message parameters.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section1082510151584"><h4 class="sectiontitle">Request Headers</h4><p id="EN-US_TOPIC_0000001399487626__p1231635205817">This request uses common headers. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section4216153718588"><h4 class="sectiontitle">Request Elements</h4><p id="EN-US_TOPIC_0000001399487626__p512465625811">This request involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section7375637599"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001399487626__screen1351602445911"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>status_code
x-obs-request-id:<span class="w"> </span>request<span class="w"> </span>id
x-obs-id-2:<span class="w"> </span>id
x-obs-version-id:<span class="w"> </span>version<span class="w"> </span>id
Content-Type:<span class="w"> </span>application/xml<span class="w"> </span>
Content-Length:<span class="w"> </span>length
Date:<span class="w"> </span>date
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;</span><span class="w"> </span>
<span class="nt">&lt;Tagging</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://obs.region.example.com/doc/2015-06-30/&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;TagSet&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Tag&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Key&gt;</span>key<span class="nt">&lt;/Key&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Value&gt;</span>value<span class="nt">&lt;/Value&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Tag&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/TagSet&gt;</span><span class="w"> </span>
<span class="nt">&lt;/Tagging&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section4327836215"><h4 class="sectiontitle">Response Headers</h4><p id="EN-US_TOPIC_0000001399487626__p1610494415574">This response uses common headers. For details, see <a href="obs_04_0013.html#obs_04_0013__d0e686">Table 1</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section2085012491723"><h4 class="sectiontitle">Response Elements</h4><p id="EN-US_TOPIC_0000001399487626__p63829146313">For more information about the object tag elements returned in the response, see <a href="obs_04_0172.html#obs_04_0172__table1181123018399">Table 3</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section75624441842"><h4 class="sectiontitle">Error Responses</h4><p id="EN-US_TOPIC_0000001399487626__p2866601656">In addition to common error codes, this API also returns others. <a href="#EN-US_TOPIC_0000001399487626__table1488314173514">Table 1</a> lists the common errors and possible causes.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001399487626__table1488314173514"></a><a name="table1488314173514"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001399487626__table1488314173514" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Error codes of obtaining object tags</caption><thead align="left"><tr id="EN-US_TOPIC_0000001399487626__row6181181352"><th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.10.3.2.4.1.1"><p id="EN-US_TOPIC_0000001399487626__p11810181514">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.019999999999996%" id="mcps1.3.10.3.2.4.1.2"><p id="EN-US_TOPIC_0000001399487626__p618131810511">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.10.3.2.4.1.3"><p id="EN-US_TOPIC_0000001399487626__p18190181851">HTTP Status Code</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001399487626__row1719418653"><td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.10.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001399487626__p1019218752">NoSuchTagSet</p>
</td>
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.10.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001399487626__p14197185516">No tags were configured for the specified object.</p>
</td>
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.10.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001399487626__p21916186514">404</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section51791023968"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001399487626__screen5561411267"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/objectname?tagging<span class="err">&amp;</span>versionId=G001018455096CE600005306000000DD<span class="w"> </span>HTTP/1.1<span class="w"> </span>
User-Agent:<span class="w"> </span>curl/7.29.0<span class="w"> </span>
Host:<span class="w"> </span>bucketname.obs.region.example.com
Accept:<span class="w"> </span>*/*<span class="w"> </span>
Date:<span class="w"> </span>Wed,<span class="w"> </span>27<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>13:25:44<span class="w"> </span>GMT<span class="w"> </span>
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001399487626__section18234571088"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001399487626__screen1219123011919"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>200<span class="w"> </span>OK<span class="w"> </span>
x-obs-request-id:<span class="w"> </span>0002B7532E0000015BEB35330C5884X1<span class="w"> </span>
x-obs-id-2:<span class="w"> </span>s12w20LYNQqSb7moq4ibgJwmQRSmVQV+rFBqplOGYkXUpXeS/nOmbkyD+E35K79j<span class="w"> </span>
x-obs-version-id:<span class="w"> </span>G001018455096CE600005306000000DD
Content-Type:<span class="w"> </span>application/xml<span class="w"> </span>
Date:<span class="w"> </span>Wed,<span class="w"> </span>27<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>13:25:44<span class="w"> </span>GMT<span class="w"> </span>
Content-Length:<span class="w"> </span>441<span class="w"> </span>
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;</span>
<span class="nt">&lt;Tagging</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://obs.region.example.com/doc/2015-06-30/&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;TagSet&gt;</span>
<span class="w"> </span><span class="nt">&lt;Tag&gt;</span>
<span class="w"> </span><span class="nt">&lt;Key&gt;</span>TagName1<span class="nt">&lt;/Key&gt;</span>
<span class="w"> </span><span class="nt">&lt;Value&gt;</span>TageSetVaule1<span class="nt">&lt;/Value&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Tag&gt;</span>
<span class="w"> </span><span class="nt">&lt;/TagSet&gt;</span>
<span class="nt">&lt;/Tagging&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_04_0079.html">Operations on Objects</a></div>
</div>
</div>
View Git Blame Copy Permalink