THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Error responses will contain a human readable message about what happened, but will also contain a numeric code describing the type of error. The following list provides an enumeration of these values with a bit of detail about the error type they represent.
Error code grouping and enumeration
| Error Code | Description | Numeric Value |
|---|---|---|
General Errors | ||
Unknown Cause | ||
| GENERIC_ERROR | Unable to match error to a more specific error code | 1000 |
Protocol Errors | ||
| VALUE_ENCODING_ERROR | Request data can not be decoded, or unable to encode response | 1100 |
| UNSUPPORTED_VERSION | Server is unable to process the given protocol version | 1101 |
| UNSUPPORTED_OPERATION | Target is unable to handle the given operation type | 1102 |
| UNSUPPORTED_AUTHENTICATION_MODE | Server doesn't support the requested authentication mode | 1103 |
| HANDSHAKE_REQUIRED | Protocol handshake has not yet been performed for this connection | 1104 |
Authentication Errors | ||
| AUTHENTICATION_FAILED | Unable to authenticate the client | 1200 |
| AUTHORIZATION_FAILED | Client isn't authorized to run the attempted request | 1201 |
| ALREADY_AUTHENTICATED | Client is trying to authenticate after already having done so | 1202 |
| AUTHENTICATION_NOT_SUPPORTED | Client is trying to authenticate on a server that doesn't support authentication | 1203 |
Server Errors | ||
| LOW_MEMORY | Server did not have enough memory to run the request | 1300 |
| DATA_UNREACHABLE | Server was unable to access the system containing the requested data | 1301 |
| OPERATION_TIMEOUT | Server was unable to complete the operation quickly enough | 1302 |
Operation Failures | ||
Generic Operation Errors | ||
| CONSTRAINT_VIOLATION | Request parameters did not match system requirements | 2000 |
| BAD_QUERY | Request is malformed or is of an unknown type | 2001 |
Region Errors | ||
| REGION_NOT_FOUND | Request is attempting to access a region which doesn't exist on the server | 2100 |
Query Specific Errors | ||
| QUERY_PARAMETER_MISMATCH | Query request does not match the expected number of parameters | 2200 |
| QUERY_BIND_FAILURE | Parameters are not of the correct type | 2201 |
| QUERY_NOT_PERMITTED | Query is not allowed on the target region | 2202 |
| QUERY_TIMEOUT | Query did not complete in time | 2203 |
Operations on the server can return error messages, which will have error codes associated with them.
Error codes are split according to functional area. The error codes for each functional area are defined in the API section for that area, as defined on the APIs page.
Error codes defined per functional area
| Error Codes for Functional Area |
|---|
| General System Error Codes |
| Authentication Specific Error Codes |