Error codes on Dapr Docs

Errors overview

Mon, 01 Jan 0001 00:00:00 +0000

An error code is a numeric or alphanumeric code that indicates the nature of an error and, when possible, why it occured.

Dapr error codes are standardized strings for over 80+ common errors across HTTP and gRPC requests when using the Dapr APIs. These codes are both:

Returned in the JSON response body of the request.
When enabled, logged in debug-level logs in the runtime.
- If you’re running in Kubernetes, error codes are logged in the sidecar.
- If you’re running in self-hosted, you can enable and run debug logs.

Error format

Dapr error codes consist of a prefix, a category, and shorthand of the error itself. For example:

Error codes reference guide

Mon, 01 Jan 0001 00:00:00 +0000

The following tables list the error codes returned by Dapr runtime. The error codes are returned in the response body of an HTTP request or in the ErrorInfo section of a gRPC status response, if one is present. An effort is underway to enrich all gRPC error responses according to the Richer Error Model. Error codes without a corresponding gRPC code indicate those errors have not yet been updated to this model.

Handling HTTP error codes

Mon, 01 Jan 0001 00:00:00 +0000

For HTTP calls made to Dapr runtime, when an error is encountered, an error JSON is returned in response body. The JSON contains an error code and an descriptive error message.

{
 "errorCode": "ERR_STATE_GET",
 "message": "Requested state key does not exist in state store."
}

Handling gRPC error codes

Mon, 01 Jan 0001 00:00:00 +0000

Initially, errors followed the Standard gRPC error model. However, to provide more detailed and informative error messages, an enhanced error model has been defined which aligns with the gRPC Richer error model.

Note

Not all Dapr errors have been converted to the richer gRPC error model.

Standard gRPC Error Model

The Standard gRPC error model is an approach to error reporting in gRPC. Each error response includes an error code and an error message. The error codes are standardized and reflect common error conditions.

Error codes on Dapr Docs

Errors overview

Error format

Error codes reference guide

Handling HTTP error codes

Related

Handling gRPC error codes

Note

Standard gRPC Error Model