Status

يحدد النوع Status نموذج خطأ منطقيًا مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات RPC API. وتستخدمه gRPC. تحتوي كل رسالة في Status على ثلاثة أجزاء من البيانات: رمز الخطأ، ورسالة الخطأ، وتفاصيل الخطأ.

يمكنك الاطّلاع على المزيد من المعلومات حول نموذج الخطأ هذا وكيفية استخدامه في دليل تصميم واجهة برمجة التطبيقات.

تمثيل JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
الحقول
code

integer

رمز الحالة الذي يجب أن يكون قيمة تعداد google.rpc.Code.
message

string

تظهر رسالة خطأ لمطوّر البرامج باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ مواجهة للمستخدم وإرسالها في الحقل google.rpc.Status.details، أو ترجمتها من قِبل البرنامج.
details[]

object

قائمة بالرسائل التي تحتوي على تفاصيل الخطأ. هناك مجموعة شائعة من أنواع الرسائل التي يمكن استخدامها في واجهات برمجة التطبيقات.

عنصر يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرف موارد منتظم (URI) يحدد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }.