vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/s3api/en-us_topic_0125560308.html
Jawei, Li 1a4c1a720a OBS s3api 2.0.38.SP5 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Jawei, Li <lijiawei5@huawei.com>
Co-committed-by: Jawei, Li <lijiawei5@huawei.com>
2022-11-16 14:51:13 +00:00

163 lines
10 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0125560308"></a><a name="EN-US_TOPIC_0125560308"></a>
<h1 class="topictitle1">List Buckets</h1>
<div id="body58557143"><p class="msonormal" id="EN-US_TOPIC_0125560308__p27236861">You can obtain the list of created buckets.</p>
<div class="section" id="EN-US_TOPIC_0125560308__section20467861"><h4 class="sectiontitle">Request Syntax</h4><pre class="screen" id="EN-US_TOPIC_0125560308__screen4932377511113">GET / HTTP/1.1
User-Agent: agent
Host: obs.example.com
Accept: */*
Date: date
Authorization: authorization</pre>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section49993022"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0125560308__p33234393">This request involves no parameters.</p>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section47284016"><h4 class="sectiontitle">Request Headers</h4><p class="MsoNormal" id="EN-US_TOPIC_0125560308__p63077327">The operation request header is the same as that of a common request. For details, see section <a href="en-us_topic_0125560462.html">Common Request Headers</a>. </p>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section22902964"><h4 class="sectiontitle">Request Elements</h4><p id="EN-US_TOPIC_0125560308__p5952620">This request involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section8232218"><h4 class="sectiontitle">Response Syntax</h4><pre class="screen" id="EN-US_TOPIC_0125560308__screen4720914211440">HTTP/1.1 status_code
Server: Server Name
x-amz-request-id: request id
x-reserved: amazon, aws and amazon web services are trademarks or registered trademarks of Amazon Technologies, Inc
x-amz-id-2: id2
Content-Type: type
Date: date
Content-Length: length
&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;
&lt;ListAllMyBucketsResult xmlns="http://obs.example.com/doc/2015-06-30/"&gt;
&lt;Owner&gt;
&lt;ID&gt;id&lt;/ID&gt;
&lt;DisplayName&gt;name&lt;/DisplayName&gt;
&lt;/Owner&gt;
&lt;Buckets&gt;
&lt;Bucket&gt;
&lt;Name&gt;bucketName&lt;/Name&gt;
&lt;CreationDate&gt;date&lt;/CreationDate&gt;
&lt;BucketType&gt;buckettype&lt;/BucketType&gt;
&lt;/Bucket&gt;
...
&lt;/Buckets&gt;
&lt;/ListAllMyBucketsResult&gt;</pre>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section6981102"><h4 class="sectiontitle">Response Headers</h4><p id="EN-US_TOPIC_0125560308__p49536469">This response uses common headers. For details about common response headers, see section <a href="en-us_topic_0125560484.html">Common Response Headers</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section62829926"><h4 class="sectiontitle">Response Elements</h4><p id="EN-US_TOPIC_0125560308__p545077">This response contains a bucket list in the XML format. <a href="#EN-US_TOPIC_0125560308__table12491043">Table 1</a> describes the elements in this response.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560308__table12491043"></a><a name="table12491043"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560308__table12491043" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="EN-US_TOPIC_0125560308__row58274075"><th align="left" class="cellrowborder" valign="top" width="37%" id="mcps1.3.8.3.2.3.1.1"><p id="EN-US_TOPIC_0125560308__p22579666">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.8.3.2.3.1.2"><p id="EN-US_TOPIC_0125560308__p17013620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560308__row35925995"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p24324511">ListAllMyBucketsResult</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p24128375">Indicates the bucket list.</p>
<p id="EN-US_TOPIC_0125560308__p15828788">Type: XML</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row8241372"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p63571381">Owner</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p49008235">Indicates the user information such as the user ID and user name or domain ID and domain name.</p>
<p id="EN-US_TOPIC_0125560308__p38420932">Type: XML</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row10244069"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p24463243">ID</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p35365703">Indicates the user ID or Domain ID.</p>
<p id="EN-US_TOPIC_0125560308__p49855871">Type: String</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row46049662"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p39035162">DisplayName</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p7731587">Indicates the user name.</p>
<p id="EN-US_TOPIC_0125560308__p2475424">Type: String</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row22278816"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p59753690">Buckets</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p8210712">Indicates the buckets that a user owns.</p>
<p id="EN-US_TOPIC_0125560308__p6787548">Type: XML</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row61087939"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p49176002">Bucket</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p23833214">Indicates details about a bucket.</p>
<p id="EN-US_TOPIC_0125560308__p13172334">Type: XML</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row51442142"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p6063946">Name</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p21417643">Indicates the bucket name.</p>
<p id="EN-US_TOPIC_0125560308__p58541067">Type: String</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row57107561"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p62309739">CreationDate</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p13924122">Indicates the date on which a bucket was created.</p>
<p id="EN-US_TOPIC_0125560308__p58208237">Type: String</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560308__row143921355132319"><td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560308__p1127120510448">BucketType</p>
</td>
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560308__p027185144419">Indicates the bucket type.</p>
<p id="EN-US_TOPIC_0125560308__p8846327172412">Type: String</p>
<p id="EN-US_TOPIC_0125560308__p19832012424">Value:</p>
<ul id="EN-US_TOPIC_0125560308__ul1387815213422"><li id="EN-US_TOPIC_0125560308__li148791321174214">OBJECT: indicates an object bucket.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section28598426"><h4 class="sectiontitle">Error Responses</h4><p id="EN-US_TOPIC_0125560308__p21003421">No special error responses are returned. For details about error responses, see <a href="en-us_topic_0125560440.html#EN-US_TOPIC_0125560440__table30733758">Table 1</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section17783544"><h4 class="sectiontitle">Sample Request</h4><pre class="screen" id="EN-US_TOPIC_0125560308__screen6260671011518">GET / HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1
Host: obs.example.com
Accept: */*
Date: Sun, 26 Sep 2010 08:24:46 GMT
Authorization: AWS 04RZT432N80TGDF2Y2G2:ZyEGq367GyGGyItzr5egJOjaqiM= </pre>
</div>
<div class="section" id="EN-US_TOPIC_0125560308__section25834168"><h4 class="sectiontitle">Sample Response</h4><pre class="screen" id="EN-US_TOPIC_0125560308__screen2790949611536">HTTP/1.1 200 OK
Server: OBS
x-amz-request-id: 9D3CC717E561E4D37A1285489689346
x-reserved: amazon, aws and amazon web services are trademarks or registered trademarks of Amazon Technologies, Inc
x-amz-id-2: OUQzQ0M3MTdFNTYxRTREMzdBMTI4NTQ4OTY4OTM0NkFBQUFBQUFBYmJiYmJiYmJD
Content-Type: application/xml
Date: Sun, 26 Sep 2010 08:28:06 GMT
Content-Length: 485
&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;
&lt;ListAllMyBucketsResult xmlns="http://obs.example.com/doc/2015-06-30/"&gt;
&lt;Owner&gt;
&lt;ID&gt;bcaf1ffd86f41caff1a493dc2ad8c2c281e37522a640e161ca5fb16fd081034f&lt;/ID&gt;
&lt;DisplayName&gt;user01&lt;/DisplayName&gt;
&lt;/Owner&gt;
&lt;Buckets&gt;
&lt;Bucket&gt;
&lt;Name&gt;bucket01&lt;/Name&gt;
&lt;CreationDate&gt;2010-09-26T03:10:23.211Z&lt;/CreationDate&gt;
&lt;BucketType&gt;OBJECT&lt;/BucketType&gt;
&lt;/Bucket&gt;
&lt;Bucket&gt;
&lt;Name&gt;bucket02&lt;/Name&gt;
&lt;CreationDate&gt;2010-09-20T12:05:46.187Z&lt;/CreationDate&gt;
&lt;BucketType&gt;OBJECT&lt;/BucketType&gt;
&lt;/Bucket&gt;
&lt;Bucket&gt;
&lt;Name&gt;bucket03&lt;/Name&gt;
&lt;CreationDate&gt;2010-09-26T08:25:13.059Z&lt;/CreationDate&gt;
&lt;BucketType&gt;OBJECT&lt;/BucketType&gt;
&lt;/Bucket&gt;
&lt;/Buckets&gt;
&lt;/ListAllMyBucketsResult&gt;</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0125560493.html">Operations on Buckets</a></div>
</div>
</div>
View Git Blame Copy Permalink