121 lines
43 KiB
ReStructuredText
121 lines
43 KiB
ReStructuredText
:original_name: dcs-api-0312043.html
|
|
|
|
.. _dcs-api-0312043:
|
|
|
|
Status Codes
|
|
============
|
|
|
|
:ref:`Table 1 <dcs-api-0312043__table5210141351517>` describes status codes.
|
|
|
|
.. _dcs-api-0312043__table5210141351517:
|
|
|
|
.. table:: **Table 1** Status codes
|
|
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Status Code | Name | Description |
|
|
+=======================+=================================+=====================================================================================================================================================================================================================================================================================================================================================+
|
|
| 100 | Continue | The server has received the initial part of the request and the client should continue to send the remaining part. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 101 | Switching Protocols | The requester has asked the server to switch protocols and the server has agreed to do so. |
|
|
| | | |
|
|
| | | The target protocol must be more advanced than the source protocol. |
|
|
| | | |
|
|
| | | For example, the current HTTP protocol is switched to a later version of HTTP. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 200 | OK | The server successfully processed the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 201 | Created | The request has been fulfilled, resulting in the creation of a new resource. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 203 | Non-Authoritative Information | The request has been fulfilled. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 204 | NoContent | The server has successfully processed the request, but is not returning any content. |
|
|
| | | |
|
|
| | | The status code is returned in response to an HTTP OPTIONS request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 205 | Reset Content | The server has successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the content. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 206 | Partial Content | The server has successfully processed a part of the GET request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 300 | Multiple Choices | There are multiple options for the requested resource. For example, this code could be used to present a list of resource characteristics and addresses from which the client such as a browser may choose. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 301 | Moved Permanently | This and all future requests should be permanently directed to the given URI indicated in this response. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 302 | Found | The requested resource was temporarily moved. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 303 | See Other | The response to the request can be found under another URI using a GET or POST method. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 304 | Not Modified | The requested resource has not been modified. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 305 | Use Proxy | The requested resource is available only through a proxy. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 306 | Unused | This HTTP status code is no longer used. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 400 | BadRequest | The request is invalid. |
|
|
| | | |
|
|
| | | The client should modify the request instead of re-initiating it. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 401 | Unauthorized | The authentication information provided by the client is incorrect or invalid. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 402 | Payment Required | Reserved for future use. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 403 | Forbidden | The server has received the request and understood it, but the server is refusing to respond to it. |
|
|
| | | |
|
|
| | | The client should modify the request instead of re-initiating it. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 404 | NotFound | The requested resource could not be found. |
|
|
| | | |
|
|
| | | The client should modify the request instead of re-initiating it. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 405 | MethodNotAllowed | A request method is not supported for the requested resource. |
|
|
| | | |
|
|
| | | The client should modify the request instead of re-initiating it. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 406 | Not Acceptable | The server could not fulfill the request according to the content characteristics of the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 407 | Proxy Authentication Required | This code is similar to 401, but indicates that the client must first authenticate itself with the proxy. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 408 | Request Time-out | The server timed out waiting for the request. |
|
|
| | | |
|
|
| | | The client may re-initiate the request without modifications at any later time. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 409 | Conflict | The request could not be processed due to a conflict in the request, such as an edit conflict between multiple simultaneous updates or the resource that the client attempts to create already exits. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 410 | Gone | The requested resource has been deleted permanently and will not be available again. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 411 | Length Required | The server refused to process the request because the request does not specify the length of its content. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 412 | Precondition Failed | The server does not meet one of the preconditions that the requester puts on the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 413 | Request Entity Too Large | The request is larger than the server is willing or able to process. |
|
|
| | | |
|
|
| | | The server may close the connection to prevent the client from continuing the request. If the server temporarily cannot process the request, the response will contain a Retry-After header field. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 414 | Request-URI Too Large | The URI provided was too long for the server to process. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 415 | Unsupported Media Type | The server does not support the media type in the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 416 | Requested range not satisfiable | The requested range is invalid. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 417 | Expectation Failed | The server fails to meet the requirements of the Expect request-header field. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 422 | UnprocessableEntity | The request was well-formed but was unable to be followed due to semantic errors. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 429 | TooManyRequests | The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 500 | InternalServerError | The server is able to receive the request but it could not understand the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 501 | Not Implemented | The server does not support the requested function. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 502 | Bad Gateway | The server was acting as a gateway or proxy and received an invalid request from a remote server. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 503 | ServiceUnavailable | The requested service is invalid. |
|
|
| | | |
|
|
| | | It is advisable for the client to modify the request instead of re-initiating the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 504 | ServerTimeout | The server could not return a timely response. The response will reach the client only if the request carries a timeout parameter. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| 505 | HTTP Version not supported | The server does not support the HTTP protocol version used in the request. |
|
|
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|