doc-exports/docs/obs/api-swift/obs_03_0018.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

176 lines
12 KiB
HTML

<a name="obs_03_0018"></a><a name="obs_03_0018"></a>
<h1 class="topictitle1">Response</h1>
<div id="body8662426"><div class="section" id="obs_03_0018__section30570743"><h4 class="sectiontitle">Response Headers</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0018__table59658522144238" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response header parameters</caption><thead align="left"><tr id="obs_03_0018__row55181501144238"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.1.2.2.4.1.1"><p id="obs_03_0018__p29104717144238">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.830000000000002%" id="mcps1.3.1.2.2.4.1.2"><p id="obs_03_0018__p8671853144238">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.75%" id="mcps1.3.1.2.2.4.1.3"><p id="obs_03_0018__p31331502144238">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0018__row13548066144238"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p23651575144238">Accept-Ranges</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p36729408144238">String</p>
<p id="obs_03_0018__p19868159191351">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p22292070144238">Type of ranges that the object accepts.</p>
</td>
</tr>
<tr id="obs_03_0018__row66410903144238"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p4540407515255">X-Account-Bytes-Used</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p51190430144238">Int</p>
<p id="obs_03_0018__p35340739191356">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p52784162144238">Total number of bytes that are stored in OBS for the account.</p>
</td>
</tr>
<tr id="obs_03_0018__row5295417144238"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p26275653144238">X-Account-Container-Count</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p47953182144238">Int</p>
<p id="obs_03_0018__p22820231191359">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p59002539144238">Number of containers in the account.</p>
</td>
</tr>
<tr id="obs_03_0018__row178807761556"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p390567281556">X-Account-Object-Count</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p94784091556">Int</p>
<p id="obs_03_0018__p6187295419141">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p295536661556">Number of objects in the account.</p>
</td>
</tr>
<tr id="obs_03_0018__row6423655915944"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p3577876015944">X-Account-Meta-name</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p1239840915944">String</p>
<p id="obs_03_0018__p2381648719145">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p6474706715944">Custom account metadata item, where <strong id="obs_03_0018__b52213166">{name}</strong> is the name of the metadata item.</p>
</td>
</tr>
<tr id="obs_03_0018__row37906154201550"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p50499596201550">X-Account-Meta-Quota-Bytes</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p8465208201615">Int</p>
<p id="obs_03_0018__p9078015201615">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p11392311201550">Quota of the account.</p>
</td>
</tr>
<tr id="obs_03_0018__row52232919105750"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p45638582105758">X-Account-Meta-Temp-URL-Key</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p5737700105758">String</p>
<p id="obs_03_0018__p2434462191419">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p62100566105758">Secret key value for TempURL.</p>
</td>
</tr>
<tr id="obs_03_0018__row48861833105755"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p13821293105758">X-Account-Meta-Temp-URL-Key-2</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p45782938105758">String</p>
<p id="obs_03_0018__p52134397191443">(Optional)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p17430479105758">A second secret key value for TempURL.</p>
</td>
</tr>
<tr id="obs_03_0018__row3636297215548"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p5971961115548">X-Account-Project-Domain-Id</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p545034715548">String</p>
<p id="obs_03_0018__p21350323191449">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p3882498015548">ID of the domain to which the account belongs.</p>
</td>
</tr>
<tr id="obs_03_0018__row22274331191328"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p25128479191336">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p22140918191336">String</p>
<p id="obs_03_0018__p65050537191336">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p181299280512">If the operation succeeds, the value is the length of the container list information.</p>
<p id="obs_03_0018__p42983877191336">If the operation fails, this value is the length of the error text in the response body.</p>
</td>
</tr>
<tr id="obs_03_0018__row21527884191330"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p13007484191336">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p46973307191336">String</p>
<p id="obs_03_0018__p20106582191336">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p18020483191336">Type of the text in the response body.</p>
</td>
</tr>
<tr id="obs_03_0018__row37183535191330"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p50703890191336">Date</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p13374419191336">Datetime</p>
<p id="obs_03_0018__p53260907191336">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p19166217191336">Transaction date and time.</p>
</td>
</tr>
<tr id="obs_03_0018__row56276345191331"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p13529200191336">X-Trans-Id</p>
<p id="obs_03_0018__p56739906191336"></p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p22123378191336">Uuid</p>
<p id="obs_03_0018__p64892680191336">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p21815704191336">A unique transaction identifier.</p>
<p id="obs_03_0018__p21232114191336"></p>
</td>
</tr>
<tr id="obs_03_0018__row1691878919160"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0018__p2824464619160">X-Timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0018__p25289134191624">Datetime</p>
<p id="obs_03_0018__p26275621191624">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="40.75%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0018__p31569453191628">Object creation time and date, in UNIX Epoch timestamp format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_03_0018__section29255058162616"><h4 class="sectiontitle">Response Body Parameters</h4><p id="obs_03_0018__p38537106162939">If the response format is json or xml, container details are shown. The following table describes the response body parameters:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0018__table64595445162712" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="obs_03_0018__row9655044162712"><th align="left" class="cellrowborder" valign="top" width="19.38%" id="mcps1.3.2.3.2.4.1.1"><p id="obs_03_0018__p59205779162712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.51%" id="mcps1.3.2.3.2.4.1.2"><p id="obs_03_0018__p30938800162712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.11%" id="mcps1.3.2.3.2.4.1.3"><p id="obs_03_0018__p23014890162712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0018__row5807421162712"><td class="cellrowborder" valign="top" width="19.38%" headers="mcps1.3.2.3.2.4.1.1 "><p id="obs_03_0018__p639084162712">name</p>
</td>
<td class="cellrowborder" valign="top" width="9.51%" headers="mcps1.3.2.3.2.4.1.2 "><p id="obs_03_0018__p51765868162712">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.2.3.2.4.1.3 "><p id="obs_03_0018__p32285797162712">Name of the container.</p>
</td>
</tr>
<tr id="obs_03_0018__row22136718162712"><td class="cellrowborder" valign="top" width="19.38%" headers="mcps1.3.2.3.2.4.1.1 "><p id="obs_03_0018__p48243694162712">count</p>
</td>
<td class="cellrowborder" valign="top" width="9.51%" headers="mcps1.3.2.3.2.4.1.2 "><p id="obs_03_0018__p15425114162712">Int</p>
</td>
<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.2.3.2.4.1.3 "><p id="obs_03_0018__p41474747162712">Number of objects in the container.</p>
</td>
</tr>
<tr id="obs_03_0018__row37728411162712"><td class="cellrowborder" valign="top" width="19.38%" headers="mcps1.3.2.3.2.4.1.1 "><p id="obs_03_0018__p36102470162712">bytes</p>
</td>
<td class="cellrowborder" valign="top" width="9.51%" headers="mcps1.3.2.3.2.4.1.2 "><p id="obs_03_0018__p38618970162712">Int</p>
</td>
<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.2.3.2.4.1.3 "><p id="obs_03_0018__p41128829162712">Total number of bytes that are stored in OBS for objects.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="note" id="obs_03_0018__note43471606154531"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0018__p55700138154531">For performance purposes, of the response headers, OBS (compatible with OpenStack Swift) does not update <strong id="obs_03_0018__b842352706174253">X-Account-Bytes-Used</strong>, <strong id="obs_03_0018__b842352706174258">X-Account-Container-Count</strong>, and <strong id="obs_03_0018__b84235270617435">X-Account-Object-Count</strong> in real time.</p>
</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>