Tài nguyên: Hoạt động
Tài nguyên này đại diện cho một hoạt động diễn ra trong thời gian dài là kết quả của một lệnh gọi API mạng.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Trường | |
---|---|
name |
Tên do máy chủ chỉ định, chỉ là duy nhất trong cùng một dịch vụ trả về tên đó ban đầu. Nếu bạn sử dụng mục ánh xạ HTTP mặc định, |
metadata |
Siêu dữ liệu dành riêng cho dịch vụ được liên kết với hoạt động. Tệp này thường chứa thông tin về tiến trình và siêu dữ liệu phổ biến, chẳng hạn như thời gian tạo. Một số dịch vụ có thể không cung cấp siêu dữ liệu như vậy. Mọi phương thức trả về một hoạt động diễn ra trong thời gian dài đều phải ghi lại loại siêu dữ liệu, nếu có. |
done |
Nếu giá trị là |
Trường nhóm result . Kết quả toán tử, có thể là error hoặc response hợp lệ. Nếu done == false , thì cả error và response đều không được đặt. Nếu done == true , bạn có thể đặt chính xác một trong số error hoặc response . Một số dịch vụ có thể không cung cấp kết quả. result chỉ có thể là một trong những trạng thái sau đây: |
|
error |
Kết quả lỗi của hoạt động trong trường hợp không thành công hoặc bị huỷ. |
response |
Phản hồi bình thường, thành công của tác vụ. Nếu phương thức ban đầu không trả về dữ liệu nào khi thành công, chẳng hạn như |
Trạng thái
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 khoá 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ý 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 |
Mã trạng thái, phải là giá trị enum của |
message |
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 |
details[] |
Danh sách các thông báo chứa 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. |
Phương thức |
|
---|---|
|
Nhận trạng thái mới nhất của một hoạt động diễn ra trong thời gian dài. |