Status

Le type Status définit un modèle d'erreur logique adapté à différents environnements de programmation, notamment les API REST et les API RPC. Il est utilisé par gRPC . Chaque message Status contient trois éléments de données : le code d'erreur, le message d'erreur et les détails de l'erreur.

Vous pouvez en savoir plus sur ce modèle d'erreur et comment l'utiliser dans le Guide de conception d'API .

Représentation JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Des champs
code

integer

Le code d'état, qui doit être une valeur énumérée de google.rpc.Code .

message

string

Un message d'erreur destiné aux développeurs, qui doit être en anglais. Tout message d'erreur destiné à l'utilisateur doit être localisé et envoyé dans le champ google.rpc.Status.details , ou localisé par le client.

details[]

object

Une liste de messages contenant les détails de l'erreur. Il existe un ensemble commun de types de messages que les API peuvent utiliser.

Un 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" } .