Status

Tipe Status mendefinisikan model kesalahan logis yang cocok untuk berbagai lingkungan pemrograman, termasuk REST API dan RPC API. Ini digunakan oleh gRPC . Setiap pesan Status berisi tiga bagian data: kode kesalahan, pesan kesalahan, dan detail kesalahan.

Anda dapat mengetahui lebih lanjut tentang model kesalahan ini dan cara mengatasinya di Panduan Desain API .

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

integer

Kode status, yang seharusnya merupakan nilai enum dari google.rpc.Code .

message

string

Pesan kesalahan yang ditujukan kepada pengembang, yang seharusnya dalam bahasa Inggris. Pesan kesalahan apa pun yang dilihat pengguna harus dilokalkan dan dikirim di bidang google.rpc.Status.details , atau dilokalkan oleh klien.

details[]

object

Daftar pesan yang berisi rincian kesalahan. Ada serangkaian jenis pesan umum yang dapat digunakan oleh API.

Objek yang berisi bidang dengan tipe arbitrer. Bidang tambahan "@type" berisi URI yang mengidentifikasi jenisnya. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" } .