vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/obs_04_0054.html
zhangyue d5b1108742 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>
2023-10-16 12:27:49 +00:00

131 lines
9.5 KiB
HTML
Raw Blame History

<a name="obs_04_0054"></a><a name="obs_04_0054"></a>
<h1 class="topictitle1">Obtaining Storage Information of a Bucket</h1>
<div id="body39746667"><div class="section" id="obs_04_0054__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="msonormal" id="obs_04_0054__p62746235">This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.</p>
<div class="note" id="obs_04_0054__note18662132495916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_04_0054__p86624244591">Because OBS bucket storage statistics are measured in the background, the storage information is not updated in real time. For this reason, you are advised not to perform real-time verification on the storage information.</p>
</div></div>
</div>
<div class="section" id="obs_04_0054__section27845207"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0054__screen65363495"><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>/?storageinfo<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_0054__section49280276"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0054__p58623360">This request contains no parameters.</p>
</div>
<div class="section" id="obs_04_0054__section40869308"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0054__p50871738">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_0054__section32279454"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0054__p41404348">This request contains no elements.</p>
</div>
<div class="section" id="obs_04_0054__section22079637"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0054__screen65417916"><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>type
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;GetBucketStorageInfoResult</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="nt">&lt;Size&gt;</span>size<span class="nt">&lt;/Size&gt;</span><span class="w"> </span>
<span class="nt">&lt;ObjectNumber&gt;</span>number<span class="nt">&lt;/ObjectNumber&gt;</span><span class="w"> </span>
<span class="nt">&lt;/GetBucketStorageInfoResult&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0054__section64499009"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0054__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_0054__section43620171"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0054__p10091901">This response contains elements of information about the used storage capacity of a bucket. <a href="#obs_04_0054__table4057783695910">Table 1</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0054__table4057783695910"></a><a name="table4057783695910"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0054__table4057783695910" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="obs_04_0054__row66246136"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0054__p64336831">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0054__p59562751">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0054__row1810620"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0054__p12442532">GetBucketStorageInfoResult</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0054__p1212185">Request result that saves bucket storage information, including the stored data size and the number of objects</p>
<p id="obs_04_0054__p10909667">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0054__row31078146"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0054__p34301896">Size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0054__p26990162">Size of stored data</p>
<p id="obs_04_0054__p41584868">Type: long</p>
</td>
</tr>
<tr id="obs_04_0054__row38719496"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0054__p49271508">ObjectNumber</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0054__p31569179">Number of objects returned</p>
<p id="obs_04_0054__p15687161">Type: integer</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0054__section57037220"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0054__p62700551">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_0054__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0054__screen8484163863919"><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>/?storageinfo<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:31:18<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:bLcdeJGYWw/eEEjMhPZx2MK5R9U=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0054__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0054__screen8485113814"><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>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>BF260000016435DD2958BFDCDB86B55E
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSitZctaPYVnat49fVMd1O+OWIP1yrg3
Content-Type:<span class="w"> </span>application/xml
WED,<span class="w"> </span>01<span class="w"> </span>Jul<span class="w"> </span>2015<span class="w"> </span>03:31:18<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>206
<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;GetBucketStorageInfoResult</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;Size&gt;</span>25490<span class="nt">&lt;/Size&gt;</span>
<span class="w"> </span><span class="nt">&lt;ObjectNumber&gt;</span>24<span class="nt">&lt;/ObjectNumber&gt;</span>
<span class="nt">&lt;/GetBucketStorageInfoResult&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