vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/s3api/en-us_topic_0125560255.html
zhangyue 5eee175e13 OBS S3 API 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-03-14 12:40:31 +00:00

376 lines
37 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0125560255"></a><a name="EN-US_TOPIC_0125560255"></a>
<h1 class="topictitle1">Request Responses</h1>
<div id="body33406397"><p id="EN-US_TOPIC_0125560255__p55740514">OBS returns an HTTP response after receiving and processing a request. A response contains a status line, response headers, and an optional response body.</p>
<div class="section" id="EN-US_TOPIC_0125560255__section31902586"><h4 class="sectiontitle">Response Syntax</h4><pre class="screen" id="EN-US_TOPIC_0125560255__screen1050869712165">Status Line: HTTP-Version Status-Code Reason-Phrase
Response Headers
&lt;Conditional Response Body&gt;</pre>
</div>
<div class="section" id="EN-US_TOPIC_0125560255__section18687820"><h4 class="sectiontitle">Status Line</h4><p id="EN-US_TOPIC_0125560255__p13566274">The first line of an HTTP response is a status line consisting of space-separated elements. <a href="#EN-US_TOPIC_0125560255__table47156901">Table 1</a> describes the elements in a status line.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table47156901"></a><a name="table47156901"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table47156901" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Status line elements</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row28699899"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.3.1.1"><p id="EN-US_TOPIC_0125560255__p42990474">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.3.1.2"><p id="EN-US_TOPIC_0125560255__p59676394">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row1949763"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p23713084">HTTP-Version</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p41711613">Indicates an HTTP version. OBS uses HTTP 1.1.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row39860200"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p7450793">Status-Code</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p66643399">Indicates a status code. This element describes the state of a response.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row62919684"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p63329656">Reason-Phrase</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p29428475">Indicates a reason phrase. This element describes a status code in a short text.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p34896312">A status code consists of three digits. The first digit defines the type of a status code. Status codes are classified into five types based on request states, as described in <a href="#EN-US_TOPIC_0125560255__table46218860">Table 2</a>.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table46218860"></a><a name="table46218860"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table46218860" frame="border" border="1" rules="all"><caption><b>Table 2 </b>OBS status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row31049086"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.5.2.3.1.1"><p id="EN-US_TOPIC_0125560255__p31948077">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.5.2.3.1.2"><p id="EN-US_TOPIC_0125560255__p37657477">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row30356781"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p42980173">1<em id="EN-US_TOPIC_0125560255__i51277242">xx</em></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p1914018265425">Indicates that a request sent by a client has been received and is being processed by the server.</p>
<p id="EN-US_TOPIC_0125560255__p59815938">This status code is returned to inform the client must wait before the request is successfully processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row1472535"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p52166545">2<em id="EN-US_TOPIC_0125560255__i66845728">xx</em></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p45794886">Indicates that a request has been received, understood, and accepted.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row9500791"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p31366578">3<em id="EN-US_TOPIC_0125560255__i13863750">xx</em></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p49222002">Indicates that a request can be successfully processed only after being redirected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row40344834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p46706151">4<em id="EN-US_TOPIC_0125560255__i17702181">xx</em></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p24590590">Indicates that a request fails to be processed due to client error. For example, a request sent by a client is invalid or uses incorrect syntax.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row19988723"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p8473833">5<em id="EN-US_TOPIC_0125560255__i9155637">xx</em></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p3409123">Indicates that a request fails to be processed due to client error.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p6579933114715">1<em id="EN-US_TOPIC_0125560255__i20007789">xx</em> status codes indicate a provisional response. <a href="#EN-US_TOPIC_0125560255__table66448310">Table 3</a> describes all 1<em id="EN-US_TOPIC_0125560255__i23054945">xx</em> status codes.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table66448310"></a><a name="table66448310"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table66448310" frame="border" border="1" rules="all"><caption><b>Table 3 </b>1<em id="EN-US_TOPIC_0125560255__i29838917">xx</em> status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row1085622"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.7.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p20826581">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.7.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p9231496">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.7.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p9553720">Returned After</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row35653836"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__ole_link19">100 Continue</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p50429634">Indicates that the initial part of the request has been received and has not yet been rejected by the server and the client should continue with its request.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.7.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul58268531"><li id="EN-US_TOPIC_0125560255__ole_link18">PUT Object</li><li id="EN-US_TOPIC_0125560255__li22130602">POST Object</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p9665336154713">2<em id="EN-US_TOPIC_0125560255__i42407107">xx</em> status codes indicate that a request has been successfully processed by the server. <a href="#EN-US_TOPIC_0125560255__table22235105164842">Table 4</a> describes all 2<em id="EN-US_TOPIC_0125560255__i44704179">xx</em> status codes.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table22235105164842"></a><a name="table22235105164842"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table22235105164842" frame="border" border="1" rules="all"><caption><b>Table 4 </b>2xx status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row58972892"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.9.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p12074919">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.9.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p38544387">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.9.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p35087639">Returned After</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row23526540"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p26601610">200 OK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p7246776">Indicates that the server has accepted a request.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul50117950"><li id="EN-US_TOPIC_0125560255__li48408370">PUT Bucket</li><li id="EN-US_TOPIC_0125560255__li33022149">HEAD Bucket</li><li id="EN-US_TOPIC_0125560255__li28763888">GET Bucket (List Objects)</li><li id="EN-US_TOPIC_0125560255__li57548404">PUT Object</li><li id="EN-US_TOPIC_0125560255__li48173595">GET Object</li><li id="EN-US_TOPIC_0125560255__li30909172">HEAD Object</li><li id="EN-US_TOPIC_0125560255__li9747098">Operations on the ACL (such as <strong id="EN-US_TOPIC_0125560255__b20615021">GET Object acl</strong>, <strong id="EN-US_TOPIC_0125560255__b51317462">PUT Object acl</strong>, <strong id="EN-US_TOPIC_0125560255__b59203974">PUT Bucket acl</strong>, and <strong id="EN-US_TOPIC_0125560255__b63073718">GET Bucket acl</strong>)</li><li id="EN-US_TOPIC_0125560255__li30792551"><strong id="EN-US_TOPIC_0125560255__b8697506">POST</strong> operations (Status code <strong id="EN-US_TOPIC_0125560255__b1671962394610">200</strong> is specified to be returned.)</li><li id="EN-US_TOPIC_0125560255__li2073919515650">Restore cold objects (The object has been restored before and the expiry date has been updated.)</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row11168697"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p32249251">201 Created</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p62052558">Indicates that a request response contains an XML file recording response details.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul60201314"><li id="EN-US_TOPIC_0125560255__li4940914"><strong id="EN-US_TOPIC_0125560255__b44468229">POST</strong> operations (Status code <strong id="EN-US_TOPIC_0125560255__b9599142820465">201</strong> is specified to be returned.)</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row57148007145442"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p64133835145450">202 Accepted</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p27458107145450">Indicates that a command for restoring a cold object is successfully delivered.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p9514167145450">The cold objects are not restored before the storage objects restore. After the cold objects are restored, <strong id="EN-US_TOPIC_0125560255__b585920175311">202</strong> is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row64669749"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p3758325">204 No Content</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p35988889">Indicates that the server has processed a request successfully and no content is returned.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul29418890"><li id="EN-US_TOPIC_0125560255__li63443418"><strong id="EN-US_TOPIC_0125560255__b34119855">DELETE</strong> Object</li><li id="EN-US_TOPIC_0125560255__li38643240"><strong id="EN-US_TOPIC_0125560255__b12244848">DELETE</strong> Bucket</li><li id="EN-US_TOPIC_0125560255__li43094775"><strong id="EN-US_TOPIC_0125560255__b52308663">POST</strong> operations (No status codes are specified to be returned.)</li><li id="EN-US_TOPIC_0125560255__li1015919"><strong id="EN-US_TOPIC_0125560255__b9143273">POST</strong> operations (Status code <strong id="EN-US_TOPIC_0125560255__b143921839104613">204</strong> is specified to be returned.)</li><li id="EN-US_TOPIC_0125560255__li15180599"><strong id="EN-US_TOPIC_0125560255__b2407664">POST</strong> operations (The status code specified to be returned is invalid.)</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row485939314559"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p42073411145525">206 Partial Content</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p52503106145525">Succeeded in downloading some of the objects.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.9.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p24893182145525">The message is returned after the objects with the <strong id="EN-US_TOPIC_0125560255__b22712046145525">Range</strong> header are successfully downloaded.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p139511239204719">3<em id="EN-US_TOPIC_0125560255__i26106012">xx</em> status codes indicate that a request can be successfully processed only after being redirected. <a href="#EN-US_TOPIC_0125560255__table20089767165948">Table 5</a> describes all 3<em id="EN-US_TOPIC_0125560255__i39474715">xx</em> status codes.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table20089767165948"></a><a name="table20089767165948"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table20089767165948" frame="border" border="1" rules="all"><caption><b>Table 5 </b>3<em id="EN-US_TOPIC_0125560255__i489241312538">xx</em> status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row52422860"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.11.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p18393235">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.11.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p13457087">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.11.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p16282296">Returned After</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row43797605"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p57945135">303 See Other</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p63044349">Indicates that a client can use another URI to obtain a specific object.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul6318648"><li id="EN-US_TOPIC_0125560255__li56867833"><strong id="EN-US_TOPIC_0125560255__b42048455">POST</strong> operations (Redirection parameters in requests are valid.)</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row42891778"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p51681963">304 Not Modified</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p25489436">Indicates that the requested resource in a <strong id="EN-US_TOPIC_0125560255__b28078335">GET</strong> request is not modified at the specified time.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul59752688"><li id="EN-US_TOPIC_0125560255__li903288">Obtaining a resource that is not modified at the specified time</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row8129598"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p54517712">307 Moved Temporarily</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p53858575">Indicates that a request has been redirected.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.11.2.4.1.3 "><ul id="EN-US_TOPIC_0125560255__ul468450"><li id="EN-US_TOPIC_0125560255__li4216055">A request is redirected after it fails to be processed by the server.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p1663154274712">4<em id="EN-US_TOPIC_0125560255__i165916208536">xx</em> status codes indicate that a request fails to be processed due to a client error. When 4<em id="EN-US_TOPIC_0125560255__i65451937165334">xx</em> status codes are returned (except response to a <em id="EN-US_TOPIC_0125560255__i52196525165334">HEAD</em> request), the server must contain an error message with an error explanation. 4<em id="EN-US_TOPIC_0125560255__i61070319537">xx</em> status codes apply to all request methods. <a href="#EN-US_TOPIC_0125560255__table61163879">Table 6</a> describes all 4<em id="EN-US_TOPIC_0125560255__i16821124112536">xx</em> status codes.</p>
<p id="EN-US_TOPIC_0125560255__ole_link17"></p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table61163879"></a><a name="table61163879"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table61163879" frame="border" border="1" rules="all"><caption><b>Table 6 </b>4<em id="EN-US_TOPIC_0125560255__i56640774">xx</em> status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row18756585"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.14.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p42888430">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.14.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p51410791">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.14.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p3524541">Returned After</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row17052375"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p39065117">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p10157945">Indicates that the syntax of a request is incorrect.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p17487184">A request in incorrect syntax or containing incorrect parameters is sent.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row23166934"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p64582388">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p63790914">Indicates that a request fails to be authenticated.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p66790376">The requested user does not exist or authentication information in a sent request is incorrect.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row64242476"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p36258058">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p51221589">Indicates that the requested resource does not exist.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p55308020">The requested resource (such as a bucket or an object) does not exist.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row28010135"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p54228432">411 Length Required</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p30426833">Indicates that the <strong id="EN-US_TOPIC_0125560255__b16832135265317">Content-Length</strong> header is missing in a request.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.14.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p35236445">A request containing no <strong id="EN-US_TOPIC_0125560255__b48692557">Content-Length</strong> header is sent.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p349552213482">5<em id="EN-US_TOPIC_0125560255__i33678668">xx</em> status codes indicate that a request fails to be processed due to a client error. A 5<em id="EN-US_TOPIC_0125560255__i43617551">xx</em> status code is returned together with a response body containing error details. 5<em id="EN-US_TOPIC_0125560255__i57013647">xx</em> status codes can be returned after requests using all HTTP methods (except HEAD) are sent. <a href="#EN-US_TOPIC_0125560255__table16341824">Table 7</a> describes all 5<em id="EN-US_TOPIC_0125560255__i54702703">xx</em> status codes.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table16341824"></a><a name="table16341824"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table16341824" frame="border" border="1" rules="all"><caption><b>Table 7 </b>5<em id="EN-US_TOPIC_0125560255__i15605454">xx</em> status codes</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row65024193"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.16.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p32468313">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.16.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p12687681">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.16.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p21069217">Returned After</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row28885026"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p57985771">500 Internal Error</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p66335909">Indicates that an error occurs on the server.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p4499576">An error occurs on the server.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row40496186"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p58965604">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p11484602">Indicates that the server is overloaded.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.16.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p57837606">The server realizes that it is processing too many requests at once.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0125560255__section33972659"><h4 class="sectiontitle">Response Headers</h4><p id="EN-US_TOPIC_0125560255__p19248251">Response headers are included in responses to provide additional information about servers and requested resources. <a href="#EN-US_TOPIC_0125560255__table53316885">Table 8</a> lists the response headers.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table53316885"></a><a name="table53316885"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table53316885" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response headers</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row38686068"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0125560255__p46563795">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0125560255__p13571075">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0125560255__p25515308">Applicable To</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row53474037"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p36429702">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p65124744">Indicates the length of a response body.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p40612898">All responses</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row29971768"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p11794154">Date</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p15802441">Indicates the date when a request response is returned.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p4929340">All responses</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row44364065"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p36719502">x-amz-request-id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p21489667">Indicates the unique identifier for an OBS request.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p62941481">All responses</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row29602422"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p48985959">x-amz-id-2</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p8439774">Indicates a special token that helps OBS troubleshoot faults.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p12533056">All responses</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row45688646"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p9792822">x-reserved</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p55021127">Indicates the copyright.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p27526304">All responses</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row48651131"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p48427543">ETag</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p30316907">Indicates the hash value of an object. The entity tag (ETag) only reflects changes to the contents of an object, not its metadata.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p39750432">Responses returned after <strong id="EN-US_TOPIC_0125560255__b22209574">PUT Object</strong>, <strong id="EN-US_TOPIC_0125560255__b65668446">GET Object</strong>, and <strong id="EN-US_TOPIC_0125560255__b61301179542">HEAD Object</strong> requests are successfully processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row23677228"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p38807334">Last-Modified</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p56386340">Indicates the date and time at which the last modification to an object is recorded.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p3890831">Responses returned after <strong id="EN-US_TOPIC_0125560255__b35017480">GET Object</strong> and <strong id="EN-US_TOPIC_0125560255__b49501814175412">HEAD Object</strong> requests are successfully processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row17843649"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0125560255__p36049434">Location</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0125560255__p34323003">Indicates the URI of an object.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0125560255__p28699853">Responses returned after a <strong id="EN-US_TOPIC_0125560255__b56972087">POST Object</strong> request is successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0125560255__section37318479"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0125560255__p59374178">A response body is included in a request response under the following conditions:</p>
<ul id="EN-US_TOPIC_0125560255__ul64605559"><li id="EN-US_TOPIC_0125560255__li44579126">Obtaining object content<p id="EN-US_TOPIC_0125560255__p65667814"><a name="EN-US_TOPIC_0125560255__li44579126"></a><a name="li44579126"></a>If a requested object is not blank, the response body is the content of the object.</p>
</li><li id="EN-US_TOPIC_0125560255__li54139417">Obtaining the ACL of a bucket or object<p id="EN-US_TOPIC_0125560255__p17492713"><a name="EN-US_TOPIC_0125560255__li54139417"></a><a name="li54139417"></a>The response body is the ACL of the requested bucket or object in the XML format.</p>
</li><li id="EN-US_TOPIC_0125560255__li23216694">Client error<p id="EN-US_TOPIC_0125560255__p32976697161310"><a name="EN-US_TOPIC_0125560255__li23216694"></a><a name="li23216694"></a>The response body describes the client error in detail in the XML format so that the user can perform further operations. For details, see <a href="en-us_topic_0125560440.html#EN-US_TOPIC_0125560440__table30733758">Table 1</a>.</p>
</li><li id="EN-US_TOPIC_0125560255__li13536461">Server error<p id="EN-US_TOPIC_0125560255__p54719288"><a name="EN-US_TOPIC_0125560255__li13536461"></a><a name="li13536461"></a>The response body contains error details in the XML format.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0125560255__section321993"><h4 class="sectiontitle">Error Response</h4><p id="EN-US_TOPIC_0125560255__p15985100122147">An error response is returned if a request is incorrect, permission is incorrect, or the requested bucket or object is not found. An error response contains error details in the XML format. The following is an example error response returned after the requested object is not found:</p>
<pre class="screen" id="EN-US_TOPIC_0125560255__screen24497373122154">&lt;Error&gt;
&lt;Code&gt;NoSuchBucket&lt;/Code&gt;
&lt;Message&gt;The specified bucket does not exist&lt;/Message&gt;
&lt;RequestId&gt;FDBD2D47937FBD89F71285474962843&lt;/RequestId&gt;
&lt;HostId&gt;RkRCRDJENDc5MzdGQkQ4OUY3MTI4NTQ3NDk2Mjg0M0FB
QUFBQUFBYmJiYmJiYmJD&lt;/HostId&gt;
……
&lt;/Error&gt; </pre>
<p id="EN-US_TOPIC_0125560255__p48615844"><a href="#EN-US_TOPIC_0125560255__table127440">Table 9</a> describes the common elements contained in an error response.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0125560255__table127440"></a><a name="table127440"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0125560255__table127440" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Error response elements</caption><thead align="left"><tr id="EN-US_TOPIC_0125560255__row14347060"><th align="left" class="cellrowborder" valign="top" width="23.5%" id="mcps1.3.6.5.2.3.1.1"><p id="EN-US_TOPIC_0125560255__p21261182">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="76.5%" id="mcps1.3.6.5.2.3.1.2"><p id="EN-US_TOPIC_0125560255__p44434164">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0125560255__row42397568"><td class="cellrowborder" valign="top" width="23.5%" headers="mcps1.3.6.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p11650951">Code</p>
</td>
<td class="cellrowborder" valign="top" width="76.5%" headers="mcps1.3.6.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p4202995">A character string that uniquely identifies an error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row37826963"><td class="cellrowborder" valign="top" width="23.5%" headers="mcps1.3.6.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p44085137">Error</p>
</td>
<td class="cellrowborder" valign="top" width="76.5%" headers="mcps1.3.6.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p14126311">Container for all error elements in the XML response body.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row60027939"><td class="cellrowborder" valign="top" width="23.5%" headers="mcps1.3.6.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p30424881">Message</p>
</td>
<td class="cellrowborder" valign="top" width="76.5%" headers="mcps1.3.6.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p48496300">Error details that help you read and understand an error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row33813517"><td class="cellrowborder" valign="top" width="23.5%" headers="mcps1.3.6.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p54540374">RequestId</p>
</td>
<td class="cellrowborder" valign="top" width="76.5%" headers="mcps1.3.6.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p55694143">The unique ID of the request whose error response is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560255__row31485239"><td class="cellrowborder" valign="top" width="23.5%" headers="mcps1.3.6.5.2.3.1.1 "><p id="EN-US_TOPIC_0125560255__p167539">HostId</p>
</td>
<td class="cellrowborder" valign="top" width="76.5%" headers="mcps1.3.6.5.2.3.1.2 "><p id="EN-US_TOPIC_0125560255__p13570724">ID of the server that returns an error response.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0125560255__p25486898">The preceding elements are commonly found in error responses in the XML format. To facilitate error diagnosis, most error responses also contain other elements to describe error details. For example, if the MD5 value calculated by OBS is inconsistent with that specified in a request for uploading an object, OBS returns an error response that contains both the calculated MD5 value and the user-defined MD5 value.</p>
<p id="EN-US_TOPIC_0125560255__p28055495"></p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0125560289.html">OBS REST APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink