Status

Loại Status xác định mô hình lỗi logic phù hợp với nhiều môi trường lập trình, bao gồm cả API REST và API RPC. gRPC sử dụng. Mỗi thông báo Status chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và chi tiết lỗi.

Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách xử lý lỗi trong Hướng dẫn thiết kế API.

Biểu diễn dưới dạng JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Trường
code

integer

Mã trạng thái phải là một giá trị enum của google.rpc.Code.

message

string

Một thông báo lỗi dành cho nhà phát triển, phải bằng tiếng Anh. Mọi thông báo lỗi dành cho người dùng phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng bản địa hoá.

details[]

object

Danh sách các thông báo cho biết thông tin chi tiết về lỗi. Có một nhóm các loại thông báo phổ biến để API sử dụng.

Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.