vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-swift/obs_03_0017.html
zhangyue 894279c39a Object Storage Service API Reference Swift V1 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-02 08:50:48 +00:00

153 lines
11 KiB
HTML
Raw Permalink Blame History

<a name="obs_03_0017"></a><a name="obs_03_0017"></a>
<h1 class="topictitle1">Request</h1>
<div id="body8662426"><div class="section" id="obs_03_0017__section39869956112928"><h4 class="sectiontitle">Method</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0017__table36630378113016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Method description</caption><thead align="left"><tr id="obs_03_0017__row48730343113016"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.1"><p id="obs_03_0017__p5336715811413">Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.2"><p id="obs_03_0017__p51296332113016"><strong id="obs_03_0017__b39273688114629">URI</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.3"><p id="obs_03_0017__p61362190113016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0017__row15388804113016"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0017__p38533588113016">GET</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0017__p52757727113245">/v1/{account}{?limit,marker,end_marker,format,prefix,delimiter}</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0017__p19784190113016">Shows details of a specified account and lists the containers, sorted by name in ascending order, in the account.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="obs_03_0017__p28859943171535"><strong id="obs_03_0017__b56669285">{account}</strong> indicates the name of an account.</p>
<p id="obs_03_0017__p41688322113723">This operation does not involve a request body.</p>
</div>
<div class="section" id="obs_03_0017__section16623225"><h4 class="sectiontitle">Example Request</h4><p id="obs_03_0017__p4713936114329">Show account details and list containers, and ask for a JSON response:</p>
</div>
<pre class="screen" id="obs_03_0017__screen21590153">curl -i $publicURL?format=json -X GET -H "X-Auth-Token:$token"</pre>
<div class="section" id="obs_03_0017__section25088150142916"><h4 class="sectiontitle">Request Headers</h4><p id="obs_03_0017__p5126889143624">Request URI parameters</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0017__table46142002143624" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0017__row38562591143624"><th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.4.3.1.4.1.1"><p id="obs_03_0017__p36562205143624">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.399999999999999%" id="mcps1.3.4.3.1.4.1.2"><p id="obs_03_0017__p11628894143624">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.4.3.1.4.1.3"><p id="obs_03_0017__p21746897143624">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0017__row15796443143624"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.4.3.1.4.1.1 "><p id="obs_03_0017__p4443488143624">{account}</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.4.3.1.4.1.2 "><p id="obs_03_0017__p24378262143624">String</p>
<p id="obs_03_0017__p18077771143624">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.4.3.1.4.1.3 "><p id="obs_03_0017__p55013324143624">A unique account name. In the current version, it indicates a unique ID for the account.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="obs_03_0017__p51956031143514">Request header parameters</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0017__table34204931143044" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0017__row58034645143044"><th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.4.5.1.4.1.1"><p id="obs_03_0017__p3185823143044">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.399999999999999%" id="mcps1.3.4.5.1.4.1.2"><p id="obs_03_0017__p40763865143044">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.4.5.1.4.1.3"><p id="obs_03_0017__p54740279143044">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0017__row42998427143044"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.4.5.1.4.1.1 "><p id="obs_03_0017__p60320524143044">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.4.5.1.4.1.2 "><p id="obs_03_0017__p54124270143044">String</p>
<p id="obs_03_0017__p63510313143110">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.4.5.1.4.1.3 "><p id="obs_03_0017__p21989736143044">Authentication token.</p>
</td>
</tr>
<tr id="obs_03_0017__row63689902143044"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.4.5.1.4.1.1 "><p id="obs_03_0017__p42395927143148">Accept</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.4.5.1.4.1.2 "><p id="obs_03_0017__p49885939143148">String</p>
<p id="obs_03_0017__p3912167714320">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.4.5.1.4.1.3 "><p id="obs_03_0017__p45612269143233">Similar to the <strong id="obs_03_0017__b45314905">format</strong> query parameter, set this header to <strong id="obs_03_0017__b5180964">application/json</strong>, <strong id="obs_03_0017__b46628683">application/xml</strong>, or <strong id="obs_03_0017__b17004965">text/xml</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="obs_03_0017__note43471606154531"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0017__p55700138154531">If the value of <strong id="obs_03_0017__b34649765">Accept</strong> is invalid, OBS (compatible with OpenStack Swift) returns the 406 (Not Acceptable) error code. Then, OpenStack Swift will process the request based on the default value of <strong id="obs_03_0017__b43412436">Accept</strong>.</p>
</div></div>
</div>
<div class="section" id="obs_03_0017__section5103708"><h4 class="sectiontitle">Request Query Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0017__table2272850011511" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request query parameters</caption><thead align="left"><tr id="obs_03_0017__row6616787111511"><th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.5.2.2.4.1.1"><p id="obs_03_0017__p5221421211511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.399999999999999%" id="mcps1.3.5.2.2.4.1.2"><p id="obs_03_0017__p149275011511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.5.2.2.4.1.3"><p id="obs_03_0017__p5380390811511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0017__row1447313211511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p3147304011511">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p6628834111511">Int</p>
<p id="obs_03_0017__p3455555314396">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p163214446133">Limits the number of containers in a query result.</p>
<p id="obs_03_0017__p95151011143">Value range: <strong id="obs_03_0017__b141971639191416">0</strong> to <strong id="obs_03_0017__b167056405140">10000</strong></p>
<p id="obs_03_0017__p9735422121419">Default value: <strong id="obs_03_0017__b75978479175449">10000</strong></p>
<p id="obs_03_0017__p64656311511">If this parameter is set to a value larger than 10000, an error is reported.</p>
</td>
</tr>
<tr id="obs_03_0017__row581906811511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p158250511511">marker</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p6107409911511">String</p>
<p id="obs_03_0017__p30504646143919">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p4805497711511">Returns container names that are greater than the specified marker.</p>
</td>
</tr>
<tr id="obs_03_0017__row2984161311511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p125161311511">end_marker</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p27063604115613">String</p>
<p id="obs_03_0017__p58024375143921">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p2455611111511">Returns container names that are smaller than the specified marker.</p>
</td>
</tr>
<tr id="obs_03_0017__row1967840711511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p5044710711511">format</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p40147841115613">String</p>
<p id="obs_03_0017__p42315028143925">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p255712211511">Sets the format of the returned container list. The valid values are <strong id="obs_03_0017__b50404064216283">plain</strong> (default), <strong id="obs_03_0017__b842352706162717">json</strong>, and <strong id="obs_03_0017__b842352706162722">xml</strong>. Its function is the same as <strong id="obs_03_0017__b842352706162739">Accept</strong>.</p>
</td>
</tr>
<tr id="obs_03_0017__row2301410311511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p5220306711511">prefix</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p16654175115613">String</p>
<p id="obs_03_0017__p14938020143938">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p4778991511511">Returns containers that have the specified prefix.</p>
</td>
</tr>
<tr id="obs_03_0017__row2745605411511"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.5.2.2.4.1.1 "><p id="obs_03_0017__p934788211511">delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="obs_03_0017__p1898097111511">Char</p>
<p id="obs_03_0017__p18750875144242">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.2.2.4.1.3 "><p id="obs_03_0017__p6106364811511">Returns the container names that are nested in the account.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0016.html">Show Account Details and List Containers</a></div>
</div>
</div>
View Git Blame Copy Permalink