Status

Typ Status definiuje model logiczny błędów, który jest odpowiedni do różnych środowisk programowania, w tym interfejsów API REST i RPC. Jest używany przez gRPC. Każdy komunikat Status zawiera 3 rodzaje danych: kod błędu, komunikat o błędzie i szczegóły błędu.

Więcej informacji o tym modelu błędu i o tym, jak z nim korzystać, znajdziesz w przewodniku po projektowaniu interfejsów API.

Zapis 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 widoczny dla deweloperów w języku angielskim. Każdy komunikat o błędzie widoczny dla użytkownika powinien być zlokalizowany i wysyłany w polu google.rpc.Status.details lub przetłumaczony przez klienta.

details[]

object

Lista komunikatów ze szczegółami błędu. Istnieje wspólny zestaw typów wiadomości używanych przez interfejsy API.

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