Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Error code grouping and enumeration

Error CodeDescriptionNumeric Value

General Errors

Unknown Cause
GENERIC_ERRORUnable to match error to a more specific error code

1000

Protocol Errors
VALUE_ENCODING_ERRORRequest data can not be decoded, or unable to encode response1100
UNSUPPORTED_VERSIONServer is unable to process the given protocol version1101
Authentication Errors
AUTHENTICATION_FAILEDUnable to authenticate the client1200
AUTHORIZATION_FAILEDClient isn't authorized to run the attempted request1201
Server Errors
LOW_MEMORYServer did not have enough memory to run the request1300
DATA_UNREACHABLEServer was unable to access the system containing the requested data1301

Operation Failures

Generic Operation Errors
CONSTRAINT_VIOLATIONRequest parameters did not match system requirements2000
BAD_QUERYRequest is malformed or is of an unknown type2001
Region Errors
REGION_NOT_FOUNDRequest is attempting to access a region which doesn't exist on the server2100
Query Specific Errors
QUERY_PARAMETER_MISMATCHQuery request does not match the expected number of parameters2200
QUERY_BIND_FAILUREParameters are not of the correct type2201
QUERY_NOT_PERMITTEDQuery is not allowed on the target region2202
QUERY_TIMEOUTQuery did not complete in time2203

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