Status

סוג Status מגדיר מודל שגיאה לוגי המתאים לסביבות תכנות שונות, כולל REST APIs ו-RPC APIs. הוא נמצא בשימוש על ידי gRPC . כל הודעת Status מכילה שלושה חלקי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

אתה יכול לגלות עוד על מודל שגיאה זה וכיצד לעבוד איתו במדריך עיצוב API .

ייצוג JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שאמור להיות ערך enum של google.rpc.Code .

message

string

הודעת שגיאה הפונה למפתח, שאמורה להיות באנגלית. כל הודעת שגיאה הפונה למשתמש צריכה להיות מקומית ולשלוח בשדה google.rpc.Status.details , או להתמקם על ידי הלקוח.

details[]

object

רשימה של הודעות הנושאות את פרטי השגיאה. יש קבוצה נפוצה של סוגי הודעות לשימוש ממשקי API.

אובייקט המכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" } .