forked from docs/doc-exports
zhangyue
8ba86cabc9
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
226 lines
17 KiB
HTML
226 lines
17 KiB
HTML
<a name="obs_04_0049"></a><a name="obs_04_0049"></a>
|
|
|
|
<h1 class="topictitle1">Configuring Tags for a Bucket</h1>
|
|
<div id="body1522727142744"><div class="section" id="obs_04_0049__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0049__p1985519852420">This operation adds tags to a bucket.</p>
|
|
<p id="obs_04_0049__p785517882418">After tags are added to a bucket, all service detail records (SDRs) generated by the requests for this bucket will have the same tags. You can categorize the SDRs for detailed cost analysis. For example, if a running application uploads data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.</p>
|
|
<p id="obs_04_0049__p1485518152413">To perform this operation, you must have the <strong id="obs_04_0049__b195451167169">PutBucketTagging</strong> permission. By default, only the bucket owner can delete 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 class="note" id="obs_04_0049__note878716573168"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_04_0049__ul1636661521717"><li id="obs_04_0049__li83661215171711">A bucket can have up to 20 tags.</li><li id="obs_04_0049__li451851791819">A tag key and key value can contain a maximum of 36 and 43 characters, respectively.</li><li id="obs_04_0049__li199962513289">Tag keys and values cannot contain commas (,), asterisks (*), vertical bars (|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or ASCII control character code (0x00 to 0x1F). These tag keys and values must be URL encoded before being sent to a server.</li></ul>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section20347124652614"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0049__screen656246211548"><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></pre></div></td><td class="code"><div><pre><span></span>PUT<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
|
|
Content-MD5:<span class="w"> </span>md5
|
|
<span class="nt"><Tagging></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><TagSet></span>
|
|
<span class="w"> </span><span class="nt"><Tag></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Key></span>Tag<span class="w"> </span>Name<span class="nt"></Key></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Value></span>Tag<span class="w"> </span>Value<span class="nt"></Value></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"></Tag></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"></TagSet></span><span class="w"> </span>
|
|
<span class="nt"></Tagging></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section6834183343213"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0049__p9381205314329">This request contains no message parameters.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section386944113319"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0049__p61556324171422"><a href="#obs_04_0049__table436706591789">Table 1</a> lists the request header.</p>
|
|
|
|
<div class="tablenoborder"><a name="obs_04_0049__table436706591789"></a><a name="table436706591789"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0049__table436706591789" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request headers</caption><thead align="left"><tr id="obs_04_0049__row532609251789"><th align="left" class="cellrowborder" valign="top" width="22.430000000000003%" id="mcps1.3.4.3.2.4.1.1"><p id="obs_04_0049__p90786001789">Header</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.260000000000005%" id="mcps1.3.4.3.2.4.1.2"><p id="obs_04_0049__p642780001789">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.310000000000002%" id="mcps1.3.4.3.2.4.1.3"><p id="obs_04_0049__p391355251789">Mandatory</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0049__row520210419261"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="obs_04_0049__p1376912802612">Content-MD5</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.4.3.2.4.1.2 "><p id="obs_04_0049__p179925362264">Base64-encoded 128-bit MD5 digest of the message according to RFC 1864. </p>
|
|
<p id="obs_04_0049__p3992123610265">Type: string</p>
|
|
<p id="obs_04_0049__p299210367269">Example: <strong id="obs_04_0049__b27324094519">n58IG6hfM7vqI4K0vnWpog==</strong></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.4.3.2.4.1.3 "><p id="obs_04_0049__p12769889268">Yes</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section1373213918368"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0049__p15861131883617">In this request, you must configure bucket tags in the request body. The tag configuration is uploaded in XML format. <a href="#obs_04_0049__table1181123018399">Table 2</a> describes the configuration elements.</p>
|
|
|
|
<div class="tablenoborder"><a name="obs_04_0049__table1181123018399"></a><a name="table1181123018399"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0049__table1181123018399" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Bucket tag configuration elements</caption><thead align="left"><tr id="obs_04_0049__row2018917307393"><th align="left" class="cellrowborder" valign="top" width="22.430000000000003%" id="mcps1.3.5.3.2.4.1.1"><p id="obs_04_0049__p19190143043913">Header</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.260000000000005%" id="mcps1.3.5.3.2.4.1.2"><p id="obs_04_0049__p019273012397">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.310000000000002%" id="mcps1.3.5.3.2.4.1.3"><p id="obs_04_0049__p2195113033915">Mandatory</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0049__row7197230193913"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0049__p125361017184212">Tagging</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0049__p6536111718422">Root element for TagSet and Tag</p>
|
|
<p id="obs_04_0049__p85368172423">Type: container</p>
|
|
<p id="obs_04_0049__p125365178429">Parent: none</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0049__p553681720423">Yes</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0049__row12641636422"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0049__p3911152616425">TagSet</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0049__p591252604217">Element of the tag set</p>
|
|
<p id="obs_04_0049__p391202634216">Type: container</p>
|
|
<p id="obs_04_0049__p4912142604210">Parent: Tagging</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0049__p3912326144211">Yes</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0049__row944320444211"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0049__p163325395428">Tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0049__p8333639114218">Information element of Tag</p>
|
|
<p id="obs_04_0049__p1233323919429">Type: container</p>
|
|
<p id="obs_04_0049__p0333163974214">Parent: TagSet</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0049__p333319390424">Yes</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0049__row1314615104218"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0049__p11495174818425">Key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0049__p74952488427">Tag name</p>
|
|
<p id="obs_04_0049__p1349514814423">Type: string</p>
|
|
<p id="obs_04_0049__p149512481428">Parent: Tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0049__p18495154864216">Yes</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0049__row13866105154213"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0049__p196161654134219">Value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0049__p19616854174215">Tag value</p>
|
|
<p id="obs_04_0049__p7616135414424">Type: string</p>
|
|
<p id="obs_04_0049__p2616105415423">Parent: Tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0049__p11616115484210">Yes</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section52164611437"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0049__screen58137431151033"><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></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-Length:<span class="w"> </span>length
|
|
Date:<span class="w"> </span>date
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section1253385718430"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0049__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_0049__section7363166184419"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0049__p1281810185018">This response contains no elements.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section8123191694414"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0049__p45601120165018">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_0049__table12876123320500">Table 3</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="obs_04_0049__table12876123320500"></a><a name="table12876123320500"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0049__table12876123320500" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Bucket tag configuration errors</caption><thead align="left"><tr id="obs_04_0049__row6301134115016"><th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.9.3.2.4.1.1"><p id="obs_04_0049__p183043420504">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_0049__p2303340505">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_0049__p330834115019">HTTP Status Code</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0049__row5311834135013"><td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.9.3.2.4.1.1 "><p id="obs_04_0049__p5311234185014">InvalidTagError</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.9.3.2.4.1.2 "><p id="obs_04_0049__p1231143405016">An invalid tag is provided when configuring bucket tags.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.9.3.2.4.1.3 "><p id="obs_04_0049__p631134165012">400 Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0049__row173123414508"><td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.9.3.2.4.1.1 "><p id="obs_04_0049__p15318348500">MalformedXMLError</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.9.3.2.4.1.2 "><p id="obs_04_0049__p431103465016">An incorrect XML format is provided when configuring bucket tags.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.9.3.2.4.1.3 "><p id="obs_04_0049__p12323342506">400 Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section14819157124617"><h4 class="sectiontitle">Sample Request</h4><p id="obs_04_0049__p16581418134619">This example adds a tag whose key is <strong id="obs_04_0049__b1277982918305">TagKey(Name1)</strong> and value is <strong id="obs_04_0049__b2136154233019">TagValue(Value1)</strong> to bucket <strong id="obs_04_0049__b9680345143014">examplebucket</strong>.</p>
|
|
<div class="codecoloring" codetype="Xml" id="obs_04_0049__screen42901510155312"><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>PUT<span class="w"> </span>/?tagging<span class="w"> </span>HTTP/1.1
|
|
User-Agent:<span class="w"> </span>curl/7.29.0
|
|
Host:<span class="w"> </span>examplebucket.obs.region.example.com
|
|
Accept:<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:22:50<span class="w"> </span>GMT
|
|
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:Pf1ZyGvVYg2BzOjokZ/BAeR1mEQ=
|
|
Content-MD5:<span class="w"> </span>MnAEvkfQIGnBpchOE2U6Og==
|
|
Content-Length:<span class="w"> </span>182
|
|
|
|
<span class="nt"><Tagging</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://obs.example.com/doc/2015-06-30/"</span><span class="nt">></span>
|
|
<span class="w"> </span><span class="nt"><TagSet></span>
|
|
<span class="w"> </span><span class="nt"><Tag></span>
|
|
<span class="w"> </span><span class="nt"><Key></span>TagKey%28Name1%29<span class="nt"></Key></span>
|
|
<span class="w"> </span><span class="nt"><Value></span>TagValue%28Value1%29<span class="nt"></Value></span>
|
|
<span class="w"> </span><span class="nt"></Tag></span>
|
|
<span class="w"> </span><span class="nt"></TagSet></span>
|
|
<span class="nt"></Tagging></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0049__section13755536443"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0049__screen18548202314552"><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></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>204<span class="w"> </span>No<span class="w"> </span>Content
|
|
Server:<span class="w"> </span>OBS
|
|
x-obs-request-id:<span class="w"> </span>BF26000001643FEBA09B1ED46932CD07
|
|
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSEZp87iEirC6DggPB5cN49pSvHBWClg
|
|
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:22:50<span class="w"> </span>GMT
|
|
</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>
|
|
|