AI-generated Key Takeaways
-
The
Statustype defines a logical error model used by gRPC for REST and RPC APIs, containing an error code, message, and details. -
Each
Statusmessage includes a status code, a developer-facing error message, and a list of error details for different programming environments. -
Developers can learn more about the
Statuserror model and usage in the API Design Guide.
Index
-
Status(message)
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC
. Each Status
message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide .
| Fields | |
|---|---|
code
|
The status code, which should be an enum value of |
message
|
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
details[]
|
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
