Status
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Le type Status définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.
Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.
| Représentation JSON |
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
| Champs |
code |
integer
Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.
|
message |
string
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.
|
details[] |
object
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/08/21 (UTC).
[null,null,["Dernière mise à jour le 2024/08/21 (UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e type is a structured approach to representing errors in systems like REST APIs and RPC APIs, encompassing an error code, message, and details for comprehensive error handling.\u003c/p\u003e\n"],["\u003cp\u003eIt's built upon a standard JSON structure with designated fields for 'code', 'message', and 'details', ensuring consistent error reporting across different platforms and programming environments.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage the accompanying API Design Guide to delve deeper into using the \u003ccode\u003eStatus\u003c/code\u003e type effectively and gain practical insights for its implementation.\u003c/p\u003e\n"]]],["The `Status` type models errors with three components: `code` (an integer representing the error), `message` (a developer-facing English error description), and `details` (a list of objects providing further error context). `details` contains an array of objects, each with a type identifier. This model is used by gRPC and suitable for REST and RPC APIs. User-facing error messages are recommended to be localized and sent in the details or on the client.\n"],null,["# Status\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nThe `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](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"code\": integer, \"message\": string, \"details\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `integer` The status code, which should be an enum value of `google.rpc.Code`. |\n| `message` | `string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details](/people/api/rest/v1/Status#FIELDS.details) field, or localized by the client. |\n| `details[]` | `object` 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 `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |"]]
