Status

Typ Status definiuje model błędów logicznych odpowiedni dla różnych środowisk programistycznych, w tym interfejsów API REST i interfejsów API RPC. Jest używany przez gRPC . Każdy komunikat Status zawiera trzy elementy danych: kod błędu, komunikat o błędzie i szczegóły błędu.

Więcej informacji na temat tego modelu błędów i sposobu pracy z nim można znaleźć w Przewodniku projektowania interfejsu API .

Reprezentacja JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Pola
code

integer

Kod stanu, który powinien być wartością wyliczeniową google.rpc.Code .

message

string

Komunikat o błędzie skierowany do programisty, który powinien być w języku angielskim. Każdy komunikat o błędzie wyświetlany użytkownikowi powinien zostać zlokalizowany i przesłany w polu google.rpc.Status.details lub zlokalizowany przez klienta.

details[]

object

Lista komunikatów zawierających szczegóły błędu. Istnieje wspólny zestaw typów komunikatów, z których mogą korzystać interfejsy API.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" } .