Open Cloud Error Handling

To handle error responses properly, you need to understand the error model shared by all Open Cloud endpoints.

Error Model

All standard data stores error responses have the same format, which includes:

• An error field, which is a high-level cause that is applicable to all Open Cloud endpoints.
• An explanatory error message, which further explains the error.
• An errorDetails object, which covers more information of the error that is specific to each API.

To analyze the root cause of an error, refer to the value of the error field and the errorDetails field. Use the message field as a supplementary for error handling, as sometimes it might not cover the same level of details as the errorDetails field.

Example Standard DataStores Error Response
{
  "error": "INVALID_ARGUMENT",
  "message": "Invalid cursor.",
  "errorDetails": [
    {
      "errorDetailType": "DatastoreErrorInfo",
      "datastoreErrorCode": "InvalidCursor"
    }
  ]
}

The example error response shows the high-level Open Cloud error as INVALID_ARGUMENT, the error message as InvalidCursor, and the errorDetails specific to data stores with the datastoreErrorCode as InvalidCursor. From the error and datastoreErrorCode fields of the response, you can understand that you passed an invalid cursor parameter that caused the error. You can then correct your cursor parameter to resolve the issue.

All ordered data stores error responses have the same format, which includes:

Example Ordered DataStores Error Response
{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid cursor."
}

The code will contain a string of the high-level error while the message will contain specific details related to the error

Error Codes

Reference the following table for a summary of all high-level Open Cloud errors.