| Appendix | |
For each failure in the Orchestrator API, the system returns an numerical error code and a text-based message specific to the type of error. The most common HTTP error code is HTTP 200 Ok, along with a response body in XML or JSON.
The table below describes the type of error corresponding to each error code.
| Error Code | Error |
|---|---|
| 200 | XML Format:
<?xml version="1.0"?> <error time=”<--Timestamp -->" action="<-- action -->" id="<-- id -->"> <-- error_message --> </error> |
| 200 | JSON
Format:{error:{“action”:”#{action}”,”time”:”#{Timestamp}”,”id”:”#{id}”,”description”:#{error_message
}}}"
|
| 400 | A bad request is sent; with invalid data, for example. |
| 401 | Authentication fails with the provided user/password, user/api_key, user/basicauth, or user/scrambled password. |
| 403 | Authorization fails with the provided user/password, user/api_key, user/basicauth, or user/scrambled password. |
| 404 | The user provides an incorrect URL. |
| 502 | An Orchestrator mongrel (UI rendering daemon) is terminated due to the longevity of the request. Clients see a Proxy error. |
| 503 | Orchestrator mongrels (UI rendering daemons) are not running. |
| connection refused | The Apache service is stopped. |