Status

Loại Status xác định mô hình lỗi logic phù hợp với các môi trường lập trình khác nhau, bao gồm API REST và API RPC. Nó được sử dụng bởi gRPC . 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ý nó trong Hướng dẫn thiết kế API .

Biểu diễn JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Lĩnh vực
code

integer

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

message

string

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 mà người dùng gặp phải phải được bản địa hóa và gửi trong trường google.rpc.Status.details hoặc được khách hàng bản địa hóa.

details[]

object

Danh sách các thông báo chứa chi tiết lỗi. Có một nhóm loại thông báo chung để API sử dụng.

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