Status

Loại Status xác định một 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à RPC. gRPC sử dụng hàm này. Mỗi thông báo Status chứa ba 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ý 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: ...,
      ...
    }
  ]
}
Các trường
code

integer

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

message

string

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

details[]

object

Danh sách thông báo chứa chi tiết 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 loại tùy ý. Trường bổ sung "@type" có chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.