Status

Der Status definiert ein logisches Fehlermodell, das für verschiedene Programmierumgebungen geeignet ist, einschließlich REST-APIs und RPC-APIs. Es wird von gRPC verwendet. Jede Status enthält drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Mehr über dieses Fehlermodell und wie man damit arbeitet, erfahren Sie im API Design Guide .

JSON-Darstellung
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der ein Enumerationswert von google.rpc.Code sein sollte.

message

string

Eine entwicklerseitige Fehlermeldung, die auf Englisch sein sollte. Jede benutzerseitige Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet oder vom Client lokalisiert werden.

details[]

object

Eine Liste von Nachrichten, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die von APIs verwendet werden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI, der den Typ identifiziert. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" } .