Status

Status türü, REST API'leri ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun olan mantıksal bir hata modelini tanımlar. gRPC tarafından kullanılır. Her Status mesajı üç parça veri içerir: hata kodu, hata mesajı ve hata ayrıntıları.

Bu hata modeli ve nasıl çalışacağı hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.

JSON gösterimi
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Alanlar
code

integer

google.rpc.Code enum değeri olması gereken durum kodu.

message

string

Geliştiriciye yönelik, İngilizce olması gereken bir hata mesajı. Kullanıcılara yönelik tüm hata mesajları, google.rpc.Status.details alanında yerelleştirilip gönderilmelidir veya istemci tarafından yerelleştirilmelidir.

details[]

object

Hata ayrıntılarını içeren iletilerin listesi. API'lerin yaygın olarak kullandığı bir ileti türü grubu vardır.

İsteğe bağlı tür türündeki alanları içeren bir nesne. Ek "@type" alanı, türü tanımlayan bir URI içeriyor. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.