doc-exports/docs/obs/api-ref/obs_04_0057.html
zhangyue 8ba86cabc9 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-05-28 10:01:19 +00:00

217 lines
15 KiB
HTML

<a name="obs_04_0057"></a><a name="obs_04_0057"></a>
<h1 class="topictitle1">Listing All Inventories of a Bucket</h1>
<div id="body1546933383180"><div class="section" id="obs_04_0057__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0057__p328123010563">OBS uses the GET method without inventory IDs to obtain all inventories of a specified bucket. Obtained inventories are returned together on only one page.</p>
<p id="obs_04_0057__p658524185">To perform this operation, you must have the <strong id="obs_04_0057__b198988291551">GetBucketInventoryConfiguration</strong> permission. By default, the bucket owner has this permission and can grant it to others.</p>
</div>
<div class="section" id="obs_04_0057__section760823317564"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0057__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>
<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>/?inventory<span class="w"> </span>HTTP/1.1
User-Agent:<span class="w"> </span>curl/7.29.0
Host:<span class="w"> </span>bucketname.obs.region.example.com
Accept:<span class="w"> </span>*/*
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_0057__section1371325895711"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0057__p191118278116">This request message does not contain the request parameters.</p>
</div>
<div class="section" id="obs_04_0057__section1082510151584"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0057__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_0057__section4216153718588"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0057__p512465625811">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0057__section7375637599"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0057__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>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span>
<span class="normal">22</span>
<span class="normal">23</span>
<span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</span></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>status_code
Server:<span class="w"> </span>OBS
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
Date:<span class="w"> </span>date
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="nt">&lt;ListInventoryConfiguration</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;InventoryConfiguration&gt;</span>
<span class="w"> </span><span class="nt">&lt;Id&gt;</span>id<span class="nt">&lt;/Id&gt;</span>
<span class="w"> </span><span class="nt">&lt;IsEnabled&gt;</span>true<span class="nt">&lt;/IsEnabled&gt;</span>
<span class="w"> </span><span class="nt">&lt;Destination&gt;</span>
<span class="w"> </span><span class="nt">&lt;Format&gt;</span>CSV<span class="nt">&lt;/Format&gt;</span>
<span class="w"> </span><span class="nt">&lt;Bucket&gt;</span>bucket<span class="nt">&lt;/Bucket&gt;</span>
<span class="w"> </span><span class="nt">&lt;Prefix&gt;</span>prefix<span class="nt">&lt;/Prefix&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Destination&gt;</span>
<span class="w"> </span><span class="nt">&lt;Schedule&gt;</span>
<span class="w"> </span><span class="nt">&lt;Frequency&gt;</span>Daily<span class="nt">&lt;/Frequency&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Schedule&gt;</span>
<span class="w"> </span><span class="nt">&lt;IncludedObjectVersions&gt;</span>Current<span class="nt">&lt;/IncludedObjectVersions&gt;</span>
<span class="w"> </span><span class="nt">&lt;OptionalFields&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>Size<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>LastModifiedDate<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>ETag<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>StorageClass<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>IsMultipartUploaded<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>ReplicationStatus<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>EncryptionStatus<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;/OptionalFields&gt;</span>
<span class="w"> </span><span class="nt">&lt;/InventoryConfiguration&gt;</span>
<span class="nt">&lt;/ListInventoryConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0057__section4327836215"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0057__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_0057__section2085012491723"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0057__p63829146313"><a href="#obs_04_0057__table1181123018399">Table 1</a> lists elements contained in the response body.</p>
<div class="tablenoborder"><a name="obs_04_0057__table1181123018399"></a><a name="table1181123018399"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0057__table1181123018399" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Bucket inventory configuration elements</caption><thead align="left"><tr id="obs_04_0057__row2018917307393"><th align="left" class="cellrowborder" valign="top" width="29.630000000000003%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0057__p19190143043913">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.37%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0057__p019273012397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0057__row7197230193913"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0057__p176001015203813"><span style="color:#444444;">ListInventoryConfiguration</span></p>
</td>
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0057__p14220164922319">List of bucket inventories.</p>
<p id="obs_04_0057__p2070447132318">Type: container</p>
</td>
</tr>
<tr id="obs_04_0057__row12641636422"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0057__p174466540382">InventoryConfiguration</p>
</td>
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0057__p1033034642512">Bucket inventory configuration. For details about the configuration elements, see <a href="obs_04_0056.html#obs_04_0056__table1181123018399">Table 2</a>.</p>
<p id="obs_04_0057__p152961348132515">Type: container</p>
<p id="obs_04_0057__p17751171123910">Parent: ListInventoryConfiguration</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0057__section75624441842"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0057__p184128334439">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_0057__section51791023968"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0057__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>/?inventory<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>Tue,<span class="w"> </span>08<span class="w"> </span>Jan<span class="w"> </span>2019<span class="w"> </span>09:32:24<span class="w"> </span>+0000
Authorization:<span class="w"> </span>OBS<span class="w"> </span>UDSIAMSTUBTEST000001:ySWncC9M08jNsyXdJLSMJkpi7XM=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0057__section18234571088"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0057__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>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span>
<span class="normal">22</span>
<span class="normal">23</span>
<span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</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>000001682CB4C2EE6808A0D8DF9F3D00
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSBjn5O7Jv9CqvUMO0BenehRdil1n8rR
Content-Type:<span class="w"> </span>application/xml
Date:<span class="w"> </span>Tue,<span class="w"> </span>08<span class="w"> </span>Jan<span class="w"> </span>2019<span class="w"> </span>09:04:30<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>626
<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;ListInventoryConfiguration</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;InventoryConfiguration&gt;</span>
<span class="w"> </span><span class="nt">&lt;Id&gt;</span>id1<span class="nt">&lt;/Id&gt;</span>
<span class="w"> </span><span class="nt">&lt;IsEnabled&gt;</span>true<span class="nt">&lt;/IsEnabled&gt;</span>
<span class="w"> </span><span class="nt">&lt;Destination&gt;</span>
<span class="w"> </span><span class="nt">&lt;Format&gt;</span>CSV<span class="nt">&lt;/Format&gt;</span>
<span class="w"> </span><span class="nt">&lt;Bucket&gt;</span>bucket<span class="nt">&lt;/Bucket&gt;</span>
<span class="w"> </span><span class="nt">&lt;Prefix&gt;</span>prefix<span class="nt">&lt;/Prefix&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Destination&gt;</span>
<span class="w"> </span><span class="nt">&lt;Schedule&gt;</span>
<span class="w"> </span><span class="nt">&lt;Frequency&gt;</span>Daily<span class="nt">&lt;/Frequency&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Schedule&gt;</span>
<span class="w"> </span><span class="nt">&lt;IncludedObjectVersions&gt;</span>Current<span class="nt">&lt;/IncludedObjectVersions&gt;</span>
<span class="w"> </span><span class="nt">&lt;OptionalFields&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>Size<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>LastModifiedDate<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>ETag<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>StorageClass<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>IsMultipartUploaded<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>ReplicationStatus<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;Field&gt;</span>EncryptionStatus<span class="nt">&lt;/Field&gt;</span>
<span class="w"> </span><span class="nt">&lt;/OptionalFields&gt;</span>
<span class="w"> </span><span class="nt">&lt;/InventoryConfiguration&gt;</span>
<span class="nt">&lt;/ListInventoryConfiguration&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>