Status

Biểu diễn dưới dạng JSON

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à API RPC. gRPC sử dụng lớp này. 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à thông tin chi tiết về 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: ..., ... } ] }

Trường

Trường
`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 hiển thị với người dùng đều phải được bản địa hoá và gửi trong trường `google.rpc.Status.details` hoặc do ứng dụng bản địa hoá.
`details[]`	`object` Danh sách các thông báo chứa thông tin chi tiết về lỗi. Có một bộ các loại thông báo phổ biến để API sử dụng. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung `"@type"` chứa URI xác định kiểu. Ví dụ: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.

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 hiển thị với người dùng đều phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc do ứng dụng bản địa hoá.

details[]

object

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

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