AI-generated Key Takeaways
-
The
Statustype is a structured approach to define errors in APIs, containing an error code, message, and details for analysis. -
The error model utilizes a JSON representation with fields for code, message, and an array for detailed error information.
-
Developers can integrate this model into REST APIs and RPC APIs, referencing the
google.rpc.Codeenum for standardized error codes. -
Error messages are intended for developers and should be in English, while user-facing messages should be handled separately via localization.
-
The
detailsfield provides flexibility by allowing arbitrary objects to convey specific error information using a URI for type identification.
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 .
| JSON representation |
|---|
{ "code" : integer , "message" : string , "details" : [ { "@type" : string , field1 : ... , ... } ] } |
| 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. An object containing fields of an arbitrary type. An additional field |
