Status

Jenis Status menjelaskan model error logis yang cocok untuk berbagai lingkungan pemrograman, termasuk REST API dan RPC API. Ini digunakan oleh gRPC. Model error dirancang untuk menjadi:

  • Mudah untuk digunakan dan dimengerti oleh sebagian besar pengguna
  • Cukup fleksibel untuk memenuhi kebutuhan tak terduga

Ringkasan

Pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error. Kode error harus berupa nilai enum dari google.rpc.Code, tetapi kode error dapat menerima kode error tambahan jika diperlukan. Pesan error harus berupa pesan berbahasa Inggris yang membantu developer memahami dan mengatasi error. Jika perlu terjemahan pesan error yang ditampilkan ke pengguna, letakkan pesan yang diterjemahkan dalam detail error atau terjemahkan di klien. Detail error opsional mungkin berisi informasi arbitrer tentang error tersebut. Ada satu set jenis detail error yang telah ditentukan dalam paket google.rpc yang dapat digunakan untuk kondisi error umum.

Pemetaan bahasa

Pesan Status merupakan representasi logis dari model error, tetapi pesan tersebut belum tentu merupakan format wire yang sebenarnya. Saat pesan Status ditampilkan di library klien dan protokol wire yang berbeda, maka pesan tersebut dapat dipetakan secara berbeda. Sebagai contoh, kemungkinan akan dipetakan ke beberapa pengecualian di Java, tetapi lebih mungkin dipetakan ke beberapa kode error dalam C.

Penggunaan lain

Model error dan pesan Status dapat digunakan dalam berbagai lingkungan, baik dengan atau tanpa API, untuk memberikan pengalaman developer yang konsisten di berbagai lingkungan.

Contoh penggunaan model error ini termasuk:

  • Error sebagian. Jika suatu layanan perlu menampilkan error sebagian kepada klien, layanan tersebut dapat menyematkan Status dalam respons normal untuk menunjukkan error sebagian.

  • Error alur kerja. Alur kerja biasanya memiliki beberapa langkah. Setiap langkah mungkin memiliki pesan Status untuk pelaporan error.

  • Operasi batch Jika klien menggunakan permintaan batch dan respons batch, pesan Status harus digunakan secara langsung di dalam respons batch, satu untuk masing-masing sub-respons error.

  • Operasi asinkron Jika panggilan API menyematkan hasil operasi asinkron dalam responsnya, status operasi tersebut harus diwakili secara langsung menggunakan pesan Status.

  • Logging. Jika beberapa error API disimpan dalam log, Status pesan dapat digunakan secara langsung setelah penghapusan yang diperlukan untuk alasan keamanan/privasi.

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

number

Kode status, harus berupa nilai enum dari google.rpc.Code.

message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.

details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.