Errors

The following sections describe the error model for v2 and v1 resource methods, respectively.

v2 resource error model

By default, resource methods respond with a 200 OK status. When requests are unsuccessful, Open Cloud returns standard error codes. All error responses have the same format, which include:

• code - Represents the HTTP status code.
• message - A message that explains the error.
• details - An object that contains more information specific to the error.

Example Error
{
  "code": "INVALID_ARGUMENT",
  "message": "The provided filter is invalid.",
  "details": [
    {
      ...
    }
  ]
}

Codes

The following table describes possible values for code.

v1 resource error model

All error responses have the same, standard 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

Codes

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