yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/obs/api-ref/obs_04_0050.html
weihongmin1 285f8e4a64 OBS API 0826 Version 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2025-10-28 10:02:29 +00:00

205 lines
16 KiB
HTML
Raw Blame History

<a name="obs_04_0050"></a><a name="obs_04_0050"></a>
<h1 class="topictitle1">Obtaining Bucket Tags</h1>
<div id="body1522727142744"><div class="section" id="obs_04_0050__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0050__p328123010563">This operation obtains information about tags of a bucket.</p>
<p id="obs_04_0050__p028114308563">To perform this operation, you must have the <strong id="obs_04_0050__b16326182918257">GetBucketTagging</strong> 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.</p>
</div>
<div class="section" id="obs_04_0050__section760823317564"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0050__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>/?tagging<span class="w"> </span>HTTP/1.1<span class="w"> </span>
Host:<span class="w"> </span>bucketname.obs.region.example.com
Date:<span class="w"> </span>date
Authorization:<span class="w"> </span>authorization<span class="w"> </span>string
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0050__section1371325895711"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0050__p1815191317587">This request contains no message parameters.</p>
</div>
<div class="section" id="obs_04_0050__section1082510151584"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0050__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="obs_04_0050__section4216153718588"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0050__p512465625811">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0050__section7375637599"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0050__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></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
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.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="obs_04_0050__section4327836215"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0050__p1512332591013">The response to the request 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="obs_04_0050__section2085012491723"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0050__p63829146313">This response contains elements to detail bucket tag configuration. <a href="#obs_04_0050__table1181123018399">Table 1</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0050__table1181123018399"></a><a name="table1181123018399"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0050__table1181123018399" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Bucket tag configuration elements</caption><thead align="left"><tr id="obs_04_0050__row2018917307393"><th align="left" class="cellrowborder" valign="top" width="26.72%" id="mcps1.3.8.3.2.4.1.1"><p id="obs_04_0050__p19190143043913">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.700000000000001%" id="mcps1.3.8.3.2.4.1.2"><p id="obs_04_0050__p17360163315619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.580000000000005%" id="mcps1.3.8.3.2.4.1.3"><p id="obs_04_0050__p019273012397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0050__row7197230193913"><td class="cellrowborder" valign="top" width="26.72%" headers="mcps1.3.8.3.2.4.1.1 "><p id="obs_04_0050__p125361017184212">Tagging</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.8.3.2.4.1.2 "><p id="obs_04_0050__p18360033767">XML</p>
</td>
<td class="cellrowborder" valign="top" width="63.580000000000005%" headers="mcps1.3.8.3.2.4.1.3 "><p id="obs_04_0050__p2495132311435"><strong id="obs_04_0050__b1792610235430">Definition</strong>:</p>
<p id="obs_04_0050__p6536111718422">Parent element of TagSet and Tag.</p>
<p id="obs_04_0050__p12974129201320"><strong id="obs_04_0050__b127992020171310">Constraints</strong>:</p>
<p id="obs_04_0050__p189761113191319">None</p>
</td>
</tr>
<tr id="obs_04_0050__row12641636422"><td class="cellrowborder" valign="top" width="26.72%" headers="mcps1.3.8.3.2.4.1.1 "><p id="obs_04_0050__p3911152616425">TagSet</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.8.3.2.4.1.2 "><p id="obs_04_0050__p3360633366">XML</p>
</td>
<td class="cellrowborder" valign="top" width="63.580000000000005%" headers="mcps1.3.8.3.2.4.1.3 "><p id="obs_04_0050__p34172324434"><strong id="obs_04_0050__b82099359432">Definition</strong>:</p>
<p id="obs_04_0050__p591252604217">Parent element of Tag. Parent: Tagging</p>
<p id="obs_04_0050__p1044302611315"><strong id="obs_04_0050__b74431526111317">Constraints</strong>:</p>
<p id="obs_04_0050__p1044362641311">A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.</p>
</td>
</tr>
<tr id="obs_04_0050__row944320444211"><td class="cellrowborder" valign="top" width="26.72%" headers="mcps1.3.8.3.2.4.1.1 "><p id="obs_04_0050__p163325395428">Tag</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.8.3.2.4.1.2 "><p id="obs_04_0050__p143602331066">XML</p>
</td>
<td class="cellrowborder" valign="top" width="63.580000000000005%" headers="mcps1.3.8.3.2.4.1.3 "><p id="obs_04_0050__p1671315427430"><strong id="obs_04_0050__b34881439432">Definition</strong>:</p>
<p id="obs_04_0050__p8333639114218">Information element of Tag Parent: TagSet</p>
<p id="obs_04_0050__p168962851314"><strong id="obs_04_0050__b136898286135">Constraints</strong>:</p>
<p id="obs_04_0050__p17689102841311">A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.</p>
</td>
</tr>
<tr id="obs_04_0050__row1314615104218"><td class="cellrowborder" valign="top" width="26.72%" headers="mcps1.3.8.3.2.4.1.1 "><p id="obs_04_0050__p11495174818425">Key</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.8.3.2.4.1.2 "><p id="obs_04_0050__p143614331368">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.580000000000005%" headers="mcps1.3.8.3.2.4.1.3 "><p id="obs_04_0050__p552516115113"><strong id="obs_04_0050__b196511117135313">Definition</strong>:</p>
<p id="obs_04_0050__p74952488427">Name of a tag. Parent: Tag</p>
<p id="obs_04_0050__p21387484532"><strong id="obs_04_0050__b1137626195416">Constraints</strong>:</p>
<ul id="obs_04_0050__ul873012181414"><li id="obs_04_0050__li072146171410">A tag key can contain a maximum of 36 characters.</li><li id="obs_04_0050__li19867313893">A tag key cannot start or end with a space or contain the following characters: ,/|&lt;&gt;=*\</li></ul>
<p id="obs_04_0050__p149512481428"><strong id="obs_04_0050__b183292471315">Range</strong>:</p>
<p id="obs_04_0050__p10120172216147">A string between 1 and 36 characters long.</p>
<p id="obs_04_0050__p828473515177"><strong id="obs_04_0050__b1251664719177">Default value</strong>:</p>
<p id="obs_04_0050__p160454111716">None</p>
</td>
</tr>
<tr id="obs_04_0050__row13866105154213"><td class="cellrowborder" valign="top" width="26.72%" headers="mcps1.3.8.3.2.4.1.1 "><p id="obs_04_0050__p196161654134219">Value</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.8.3.2.4.1.2 "><p id="obs_04_0050__p93616331265">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.580000000000005%" headers="mcps1.3.8.3.2.4.1.3 "><p id="obs_04_0050__p193579331545"><strong id="obs_04_0050__b1690337135412">Definition</strong>:</p>
<p id="obs_04_0050__p19616854174215">Tag value. Parent: Tag</p>
<p id="obs_04_0050__p874071055416"><strong id="obs_04_0050__b631714299549">Constraints</strong>:</p>
<ul id="obs_04_0050__ul011114014143"><li id="obs_04_0050__li9346151711416">A tag value can contain a maximum of 43 characters.</li><li id="obs_04_0050__li119411850101217">A tag value cannot contain the following characters: ,/|&lt;&gt;=*\</li></ul>
<p id="obs_04_0050__p15822812135"><strong id="obs_04_0050__b329612861318">Range</strong>:</p>
<p id="obs_04_0050__p1469512261713">A string of 0 (included) to 43 (excluded) characters.</p>
<p id="obs_04_0050__p190412261173"><strong id="obs_04_0050__b1027914511174">Default value</strong>:</p>
<p id="obs_04_0050__p13767123014175">None</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0050__section75624441842"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0050__p2866601656">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 <a href="#obs_04_0050__table1488314173514">Table 2</a>.</p>
<div class="tablenoborder"><a name="obs_04_0050__table1488314173514"></a><a name="table1488314173514"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0050__table1488314173514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Bucket tag configuration errors</caption><thead align="left"><tr id="obs_04_0050__row6181181352"><th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.9.3.2.4.1.1"><p id="obs_04_0050__p11810181514">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.019999999999996%" id="mcps1.3.9.3.2.4.1.2"><p id="obs_04_0050__p618131810511">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.9.3.2.4.1.3"><p id="obs_04_0050__p18190181851">HTTP Status Code</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0050__row1719418653"><td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.9.3.2.4.1.1 "><p id="obs_04_0050__p1019218752">NoSuchTagSet</p>
</td>
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.9.3.2.4.1.2 "><p id="obs_04_0050__p14197185516">The specified bucket does not have any tags.</p>
</td>
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.9.3.2.4.1.3 "><p id="obs_04_0050__p21916186514">404 Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0050__section51791023968"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0050__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>/?tagging<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>examplebucket.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="obs_04_0050__section18234571088"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0050__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></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>
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.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>TagSetValue1<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_0026.html">Advanced Bucket Settings</a></div>
</div>
</div>
View Git Blame Copy Permalink