doc-exports/docs/apiu/guidelines/apig-en-api-180328012.html
Chen, Junjie 97b6825626 APIU Guidelines 20240812 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-08-13 10:31:24 +00:00

108 lines
8.8 KiB
HTML

<a name="apig-en-api-180328012"></a><a name="apig-en-api-180328012"></a>
<h1 class="topictitle1">HTTP Status Codes</h1>
<div id="body1537511483336"><p id="apig-en-api-180328012__p8060118"><a href="#apig-en-api-180328012__table11812530035">Table 1</a> describes common status codes.</p>
<div class="tablenoborder"><a name="apig-en-api-180328012__table11812530035"></a><a name="table11812530035"></a><table cellpadding="4" cellspacing="0" summary="" id="apig-en-api-180328012__table11812530035" frame="border" border="1" rules="all"><caption><b>Table 1 </b>HTTP request status codes</caption><thead align="left"><tr id="apig-en-api-180328012__row9812123010311"><th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.2.2.3.1.1"><p id="apig-en-api-180328012__p581216302032">Return Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71%" id="mcps1.3.2.2.3.1.2"><p id="apig-en-api-180328012__p1581214303317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-en-api-180328012__row88125307316"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p11812430435">200 OK</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p5812153017318">The request has been processed successfully.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row181212307316"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p198122302311">204 No Content</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p4812930139">The server does not return any information.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row581213305320"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p19812153018318">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1857918225217">The server failed to process the request. Possible causes include:</p>
<ol id="apig-en-api-180328012__ol11564122217211"><li id="apig-en-api-180328012__li14515427112119">The request could not be parsed by the server due to incorrect syntax.</li><li id="apig-en-api-180328012__li19565142215214">Request parameters are incorrect.</li></ol>
</td>
</tr>
<tr id="apig-en-api-180328012__row781273013311"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p88121730735">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p138128301738">The request requires user authentication. For example, the username and password are required.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row38129301312"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p12812123018318">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p6812133010315">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row8812133012318"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p188121530331">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p6812163012317">The request failed because the requested resource could not be found on the server.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row1481212304316"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p128121930631">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p14812730536">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row16812530536"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p981211301319">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1581217301832">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row7812130034"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p8812630636">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1812113018316">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row781218301317"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p1081223013311">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p481311301632">The request timed out.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row3813830337"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p18813153014315">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p138138305312">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row20813430832"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p8813113016319">410 Gone</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1681353016313">The requested resource is not available on the server and no known forwarding address is provided.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row1813630533"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p0813630238">412 Precondition Failed</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p68130301535">One or more conditions specified in the request header are not met when the server tests the conditions.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row4813830332"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p198131230839">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p158131830431">The server failed to process the request due to an unexpected condition.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row581312302312"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p1081393018315">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1681333017319">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row168131830135"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p481319301310">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p188132300316">Failed to complete the request because the server has received an invalid response.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row158131330231"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p12813530636">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1581314301330">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="apig-en-api-180328012__row98135302033"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.3.1.1 "><p id="apig-en-api-180328012__p13813183014312">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.2.2.3.1.2 "><p id="apig-en-api-180328012__p1481373019313">The gateway timed out.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>