doc-exports/docs/obs/api-ref/obs_04_0053.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

117 lines
8.6 KiB
HTML

<a name="obs_04_0053"></a><a name="obs_04_0053"></a>
<h1 class="topictitle1">Querying Bucket Storage Quota</h1>
<div id="body7940910"><div class="section" id="obs_04_0053__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="msonormal" id="obs_04_0053__p12427570">A bucket owner can query the bucket storage quota, but a bucket owner who is frozen due to arrears cannot. The bucket storage quota is measured by byte. <strong id="obs_04_0053__b193051652122919">0</strong> indicates that no upper limit is set.</p>
</div>
<div class="section" id="obs_04_0053__section44739271"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0053__screen39233970"><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>/?quota<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
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0053__section263"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0053__p47928729">This request contains no message parameters.</p>
</div>
<div class="section" id="obs_04_0053__section2369"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0053__p57021840">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_0053__section21328"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0053__p28534830">This request contains no elements.</p>
</div>
<div class="section" id="obs_04_0053__section191956"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0053__screen29619869"><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></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>status_code
Date:<span class="w"> </span>date
Content-Type:<span class="w"> </span>application/xml<span class="w"> </span>
Content-Length:<span class="w"> </span>length
<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;Quota</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="w"> </span><span class="nt">&lt;StorageQuota&gt;</span>quota<span class="nt">&lt;/StorageQuota&gt;</span><span class="w"> </span>
<span class="nt">&lt;/Quota&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0053__section1727606"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0053__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_0053__section15548455"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0053__p65060221">This response contains elements of information about the bucket quota. <a href="#obs_04_0053__d0e8370">Table 1</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0053__d0e8370"></a><a name="d0e8370"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0053__d0e8370" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="obs_04_0053__row7433603"><th align="left" class="cellrowborder" valign="top" width="39.39393939393939%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0053__p65251010">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.60606060606061%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0053__p54911228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0053__row33402770"><td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0053__p21269859">Quota</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0053__p45137020">Bucket storage quota. This element contains the StorageQuota element.</p>
<p id="obs_04_0053__p3580004">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0053__row32220038"><td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0053__p59686313">StorageQuota</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0053__p2753164">Bucket storage quota quantity. The unit is byte. </p>
<p id="obs_04_0053__p24778477">Type: string</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0053__section5718368"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0053__p60899603">No special error responses are returned. For details about error responses, see <a href="obs_04_0115.html#obs_04_0115__d0e843">Table 2</a>.</p>
</div>
<div class="section" id="obs_04_0053__section14819157124617"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0053__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></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/?quota<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>01<span class="w"> </span>Jul<span class="w"> </span>2015<span class="w"> </span>03:27:45<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:8m4bW1gFCNeXQlfu45uO2gpo7l8=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0053__section13755536443"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0053__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>
<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></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>200<span class="w"> </span>OK
Server:<span class="w"> </span>OBS
x-obs-request-id:<span class="w"> </span>BF260000016436B55D8DED9AE26C4D18
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSs2Q5vz5AfpAJ/CMNgCfo2hmDowp7M9
Content-Type:<span class="w"> </span>application/xml
Date:<span class="w"> </span>WED,<span class="w"> </span>01<span class="w"> </span>Jul<span class="w"> </span>2015<span class="w"> </span>03:27:45<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>150
<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;Quota</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;StorageQuota&gt;</span>0<span class="nt">&lt;/StorageQuota&gt;</span>
<span class="nt">&lt;/Quota&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>