forked from docs/doc-exports
zhangyue
7d2a7ec198
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
241 lines
17 KiB
HTML
241 lines
17 KiB
HTML
<a name="obs_04_0020"></a><a name="obs_04_0020"></a>
|
|
|
|
<h1 class="topictitle1">Listing Buckets</h1>
|
|
<div id="body23756221"><div class="section" id="obs_04_0020__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0020__p753105884719">You can perform this operation to list all buckets that you have created across all regions.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section65384058"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0020__screen45205739"><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>/<span class="w"> </span>HTTP/1.1<span class="w"> </span>
|
|
Host:<span class="w"> </span>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="note" id="obs_04_0020__note19290105612398"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_04_0020__p52905560398">Regardless of the endpoint you specified, a list of buckets spanning all regions is returned.</p>
|
|
<p id="obs_04_0020__p762241611019">Do not list buckets during bucket creation.</p>
|
|
</div></div>
|
|
<div class="section" id="obs_04_0020__section51585610"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0020__p40868721">This request contains no parameters.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section61617313"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0020__p22032077">This request header uses common message fields. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>.</p>
|
|
<p class="MsoNormal" id="obs_04_0020__p63077327">The operation message header is the same as that of a common request. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>. However, this request can contain additional headers. The following table describes the additional headers for this request.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0020__table57087753" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Additional request headers</caption><thead align="left"><tr id="obs_04_0020__row63312464"><th align="left" class="cellrowborder" valign="top" width="24.560000000000002%" id="mcps1.3.5.4.2.4.1.1"><p id="obs_04_0020__p28035972">Header</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.11%" id="mcps1.3.5.4.2.4.1.2"><p id="obs_04_0020__p37128967">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.33%" id="mcps1.3.5.4.2.4.1.3"><p id="obs_04_0020__p22145185"><strong id="obs_04_0020__b20163659151919">Mandatory (Yes/No)</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0020__row37712700"><td class="cellrowborder" valign="top" width="24.560000000000002%" headers="mcps1.3.5.4.2.4.1.1 "><p id="obs_04_0020__p208796112252">x-obs-bucket-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.11%" headers="mcps1.3.5.4.2.4.1.2 "><p id="obs_04_0020__p1393465562812">This header field is used to specify the content to be obtained.</p>
|
|
<p id="obs_04_0020__p10304414103017">Value: </p>
|
|
<ul id="obs_04_0020__ul18561616163110"><li id="obs_04_0020__li18561316133117"><strong id="obs_04_0020__b766791222818">OBJECT</strong>: Obtain the list of all buckets.</li><li id="obs_04_0020__li1549151819314"><strong id="obs_04_0020__b818241502818">POSIX</strong>: Obtain the list of all parallel file systems.</li></ul>
|
|
<p id="obs_04_0020__p162811316112719">If this header is not carried, the list of all buckets and parallel file systems is obtained.</p>
|
|
<p id="obs_04_0020__p1878174975410">Example: <strong id="obs_04_0020__b5801103334620">x-obs-bucket-type: POSIX</strong></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.5.4.2.4.1.3 "><p id="obs_04_0020__p30276635">No</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section17684911"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0020__p22366230">The request does not use request elements.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section24946477"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0020__screen66834225"><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></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>HTTP/1.1<span class="w"> </span>status_code
|
|
Content-Type:<span class="w"> </span>type
|
|
Date:<span class="w"> </span>date
|
|
Content-Length:<span class="w"> </span>length
|
|
|
|
<span class="cp"><?xml version="1.0" encoding="UTF-8" standalone="yes"?></span><span class="w"> </span>
|
|
<span class="nt"><ListAllMyBucketsResult</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://obs.region.example.com/doc/2015-06-30/"</span><span class="nt">></span>
|
|
<span class="w"> </span><span class="nt"><Owner></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><ID></span>id<span class="nt"></ID></span>
|
|
<span class="w"> </span><span class="nt"></Owner></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Buckets></span>
|
|
<span class="w"> </span><span class="nt"><Bucket></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Name></span>bucketName<span class="nt"></Name></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><CreationDate></span>date<span class="nt"></CreationDate></span>
|
|
<span class="w"> </span><span class="nt"><Location></span>region<span class="nt"></Location></span>
|
|
<span class="w"> </span><span class="nt"><BucketType></span>buckettype<span class="nt"></BucketType></span>
|
|
<span class="w"> </span><span class="nt"></Bucket></span><span class="w"> </span>
|
|
<span class="w"> </span>...<span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"></Buckets></span><span class="w"> </span>
|
|
<span class="nt"></ListAllMyBucketsResult></span><span class="w"> </span>
|
|
</pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section23191709"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0020__p66812821">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_0020__section7398790"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0020__p52620452">This response contains the XML list of buckets owned by the user. <a href="#obs_04_0020__table3679815894442">Table 2</a> describes the elements.</p>
|
|
|
|
<div class="tablenoborder"><a name="obs_04_0020__table3679815894442"></a><a name="table3679815894442"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0020__table3679815894442" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response elements</caption><thead align="left"><tr id="obs_04_0020__row20543572"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.9.3.2.3.1.1"><p id="obs_04_0020__p53416658"><strong id="obs_04_0020__b19713818173913">Element</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.9.3.2.3.1.2"><p id="obs_04_0020__p17602688"><strong id="obs_04_0020__b1387212255392">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0020__row14567053"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p39080636">ListAllMyBucketsResult</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p11414972">List of buckets created by the user</p>
|
|
<p id="obs_04_0020__p35625890">Type: XML</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row52197557"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p143694">Owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p11639215">Bucket owner information, including the tenant ID.</p>
|
|
<p id="obs_04_0020__p37644074">Type: XML</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row3252353"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p62114027">ID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p65180310">Domain ID (account ID) of a user.</p>
|
|
<p id="obs_04_0020__p49751883">Type: string</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row61424743"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p9348268">Buckets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p19012258">Buckets owned by the user</p>
|
|
<p id="obs_04_0020__p36892599">Type: XML</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row63597936"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p51159231">Bucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p50257079">Details about a bucket</p>
|
|
<p id="obs_04_0020__p49660529">Type: XML</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row44291583"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p30848447">Name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p15696288">Bucket name</p>
|
|
<p id="obs_04_0020__p7048868">Type: string</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row63439817"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p38351587">CreationDate</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p19470870">Creation time of the bucket</p>
|
|
<p id="obs_04_0020__p41020104">Type: string</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row172523593133"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p2253125951316">Location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p1625385914134">Location of the bucket</p>
|
|
<p id="obs_04_0020__p930953141417">Type: string</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0020__row2027165118447"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0020__p1127120510448">BucketType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0020__p027185144419">Bucket type</p>
|
|
<p id="obs_04_0020__p1453610954511">Type: string</p>
|
|
<ul id="obs_04_0020__ul13905114810473"><li id="obs_04_0020__li1690514486477"><strong id="obs_04_0020__b9433474163">OBJECT</strong>: indicates a bucket.</li><li id="obs_04_0020__li6905154817478"><strong id="obs_04_0020__b1821431741714">POSIX</strong>: a parallel file system.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section66589115"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0020__p34294098">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_0020__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0020__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>/<span class="w"> </span>HTTP/1.1
|
|
User-Agent:<span class="w"> </span>curl/7.29.0
|
|
Host:<span class="w"> </span>obs.region.example.com
|
|
Accept:<span class="w"> </span>*/*
|
|
Date:<span class="w"> </span>Mon,<span class="w"> </span>25<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>05:37:12<span class="w"> </span>+0000
|
|
Authorization:<span class="w"> </span>OBS<span class="w"> </span>GKDF4C7Q6SI0IPGTXTJN:9HXkVQIiQKw33UEmyBI4rWrzmic=<span class="w"> </span>
|
|
</pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0020__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0020__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>
|
|
<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></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>BF260000016435722C11379647A8A00A
|
|
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSGGDRUM62QZi3hGP8Fz3gOloYCfZ39U
|
|
Content-Type:<span class="w"> </span>application/xml
|
|
Date:<span class="w"> </span>Mon,<span class="w"> </span>25<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>05:37:12<span class="w"> </span>GMT
|
|
Content-Length:<span class="w"> </span>460
|
|
|
|
<span class="cp"><?xml version="1.0" encoding="UTF-8" standalone="yes"?></span>
|
|
<span class="nt"><ListAllMyBucketsResult</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"><Owner></span>
|
|
<span class="w"> </span><span class="nt"><ID></span>783fc6652cf246c096ea836694f71855<span class="nt"></ID></span>
|
|
<span class="w"> </span><span class="nt"></Owner></span>
|
|
<span class="w"> </span><span class="nt"><Buckets></span>
|
|
<span class="w"> </span><span class="nt"><Bucket></span>
|
|
<span class="w"> </span><span class="nt"><Name></span>examplebucket01<span class="nt"></Name></span>
|
|
<span class="w"> </span><span class="nt"><CreationDate></span>2018-06-21T09:15:01.032Z<span class="nt"></CreationDate></span>
|
|
<span class="w"> </span><span class="nt"><Location></span>region<span class="nt"></Location></span>
|
|
<span class="w"> </span><span class="nt"><BucketType></span>OBJECT<span class="nt"></BucketType></span>
|
|
<span class="w"> </span><span class="nt"></Bucket></span>
|
|
<span class="w"> </span><span class="nt"><Bucket></span>
|
|
<span class="w"> </span><span class="nt"><Name></span>examplebucket02<span class="nt"></Name></span>
|
|
<span class="w"> </span><span class="nt"><CreationDate></span>2018-06-22T03:56:33.700Z<span class="nt"></CreationDate></span>
|
|
<span class="w"> </span><span class="nt"><Location></span>region<span class="nt"></Location></span>
|
|
<span class="w"> </span><span class="nt"><BucketType></span>OBJECT<span class="nt"></BucketType></span>
|
|
<span class="w"> </span><span class="nt"></Bucket></span>
|
|
<span class="w"> </span><span class="nt"></Buckets></span>
|
|
<span class="nt"></ListAllMyBucketsResult></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_0019.html">Operations on Buckets</a></div>
|
|
</div>
|
|
</div>
|
|
|