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 công cụ 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 làm việc với mô hình đó 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 nhà phát triển phải hiển thị 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 phải được ứng dụng khách bản địa hoá.

details[]

object

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