RESTful API responds to each request with an HTTP status code and a server status
code.
- HTTP status code
- The HTTP status code is a quick indicator of whether the request succeeded. This status code is
also helpful for automation scripts that do not parse error responses in their entirety.
- Server status code
- The server status code is a more detailed error information to assist you in
troubleshooting.
The status codes are enumerated as detailed in the following tables.
Table 1. HTTP status codes
| HTTP status code |
HTTP message |
Description |
| 200 |
OK |
The request succeeded. The response contains either a list of resources (in
case of query) or is empty. |
| 201 |
Created |
The request succeeded. A new resource is created. The response contains the
new URL for this resource. |
| 202 |
Accepted |
The request has been accepted, and under processing. |
| 301 |
Moved Permanently |
The resource has been moved to the new URL(s) permanently. |
| 400 |
Bad request |
The request contains invalid scope keywords, or invalid URL parameters.
Examples of invalid URL parameters are: non numeric values, redundant parameters, etc. |
| 401 |
Unauthorized |
The user credentials that were provided are not valid. |
| 404 |
Not found |
The request addresses non existing resources. |
| 405 |
Method Not Allowed |
The specified HTTP Method for the URL does not supported. |
| 500 |
Internal Server error |
The request is valid, but some application level error occurred. See server
status for more information. |
| 503 |
Service Unavailable |
The service is temporarily unavailable. |
Table 2. Server status codes
| HTTP status code |
Server status code |
Server message |
Description |
| 200 |
empty |
The operation completed successfully. |
The request succeeded. The response contains either a list of resources (in
case of query) or empty. |
| 201 |
empty |
The operation completed successfully. |
The request succeeded. A new resource is created. The response contains the
new URL for this resource. |
| 202 |
empty |
The operation completed successfully. |
The request succeeded to be submitted. But it is still under processing. A
resource is created or updated. If it is a creation operation, the response contains the new URL for
this resource. |
| 301 |
- |
- |
The resource has been moved permanently. The HTTP header attribute,
"Location", gives the new URL |
| 400, 401, 500, 503 |
BEXXXXXX |
A short message which describes the code. |
The request failed. A message describes the problem. The codes from the API
server begin with BE7A. Other BE codes are from the DS8000 microcode level. |
| 404 |
- |
- |
The request addresses nonexistent resources. The response only contains HTTP
header. No response body is returned. |
| 405 |
- |
- |
The HTTP method for the request addresses is not supported. |