Code

Mã lỗi chính tắc cho API gRPC.

Đôi khi, có thể áp dụng nhiều mã lỗi. Dịch vụ sẽ trả về mã lỗi cụ thể nhất có thể áp dụng. Ví dụ: ưu tiên OUT_OF_RANGE hơn FAILED_PRECONDITION nếu áp dụng cả hai mã. Tương tự như vậy, hãy ưu tiên NOT_FOUND hoặc ALREADY_EXISTS hơn FAILED_PRECONDITION.

Enum
OK

Không phải là lỗi; đã trả về thành công.

Liên kết HTTP: 200 OK

CANCELLED

Thao tác đã bị huỷ, thường là do người gọi thực hiện.

Liên kết HTTP: Yêu cầu đã đóng ứng dụng khách 499

UNKNOWN

Lỗi không xác định. Ví dụ: lỗi này có thể được trả về khi một giá trị Status nhận được từ một vùng địa chỉ khác thuộc về một vùng lỗi không xác định trong vùng địa chỉ này. Ngoài ra, các lỗi do các API nêu ra không trả về đủ thông tin lỗi có thể được chuyển đổi thành lỗi này.

Liên kết HTTP: Lỗi máy chủ nội bộ 500

INVALID_ARGUMENT

Máy khách đã chỉ định một đối số không hợp lệ. Vui lòng lưu ý điều này khác với FAILED_PRECONDITION. INVALID_ARGUMENT cho biết các đối số có vấn đề bất kể trạng thái của hệ thống (ví dụ: tên tệp không đúng định dạng).

Liên kết HTTP: 400 yêu cầu không hợp lệ

DEADLINE_EXCEEDED

Thời hạn đã hết hạn trước khi hoạt động có thể hoàn tất. Đối với các hoạt động thay đổi trạng thái của hệ thống, lỗi này có thể được trả về ngay cả khi hoạt động đã hoàn tất thành công. Ví dụ: phản hồi thành công từ máy chủ có thể đã bị trì hoãn đủ lâu để hết hạn.

Liên kết HTTP: Thời gian chờ cổng 504

NOT_FOUND

Không tìm thấy một số thực thể được yêu cầu (ví dụ: tệp hoặc thư mục).

Lưu ý dành cho nhà phát triển máy chủ: nếu một yêu cầu bị từ chối đối với toàn bộ một nhóm người dùng, chẳng hạn như phát hành tính năng dần dần hoặc danh sách cho phép không được ghi lại, thì hệ thống có thể sử dụng NOT_FOUND. Nếu yêu cầu của một số người dùng trong một lớp người dùng (chẳng hạn như kiểm soát quyền truy cập dựa trên người dùng) bị từ chối, thì bạn phải sử dụng PERMISSION_DENIED.

Liên kết HTTP: Không tìm thấy lỗi 404

ALREADY_EXISTS

Mục mà ứng dụng đã cố gắng tạo (ví dụ: tệp hoặc thư mục) đã tồn tại.

Liên kết HTTP: Xung đột 409

PERMISSION_DENIED

Phương thức gọi không có quyền thực thi thao tác đã chỉ định. Không được dùng PERMISSION_DENIED cho các lần từ chối do việc sử dụng hết một số tài nguyên (sử dụng RESOURCE_EXHAUSTED để thay thế cho các lỗi đó). Không được sử dụng PERMISSION_DENIED nếu không thể xác định người gọi (thay vào đó, sử dụng UNAUTHENTICATED cho các lỗi đó). Mã lỗi này không ngụ ý rằng yêu cầu hợp lệ hoặc thực thể được yêu cầu tồn tại hay đáp ứng các điều kiện tiên quyết khác.

Liên kết HTTP: 403 bị cấm

UNAUTHENTICATED

Yêu cầu không có thông tin xác thực hợp lệ cho thao tác.

Liên kết HTTP: 401 trái phép

RESOURCE_EXHAUSTED

Một số tài nguyên đã hết, có thể là hạn mức cho mỗi người dùng hoặc có thể là toàn bộ hệ thống tệp đã hết dung lượng.

Liên kết HTTP: 429 Quá nhiều yêu cầu

FAILED_PRECONDITION

Thao tác này đã bị từ chối vì hệ thống không ở trạng thái cần thiết để thực thi thao tác. Ví dụ: thư mục cần xoá không để trống, thao tác rmdir được áp dụng cho một thư mục không phải thư mục, v.v.

Người triển khai dịch vụ có thể sử dụng các nguyên tắc sau để quyết định giữa FAILED_PRECONDITION, ABORTEDUNAVAILABLE: (a) Sử dụng UNAVAILABLE nếu ứng dụng chỉ có thể thử lại cuộc gọi không thành công. (b) Sử dụng ABORTED nếu ứng dụng nên thử lại ở cấp cao hơn. Ví dụ: khi kiểm thử và thiết lập do ứng dụng chỉ định không thành công, cho biết ứng dụng nên khởi động lại trình tự đọc-sửa đổi-ghi. (c) Sử dụng FAILED_PRECONDITION nếu ứng dụng không thử lại cho đến khi trạng thái hệ thống được khắc phục rõ ràng. Ví dụ: nếu "rmdir" không hoạt động vì thư mục không trống, thì FAILED_PRECONDITION sẽ được trả về vì ứng dụng không được thử lại trừ khi các tệp bị xóa khỏi thư mục.

Liên kết HTTP: 400 yêu cầu không hợp lệ

ABORTED

Hoạt động bị huỷ, thường là do vấn đề đồng thời, chẳng hạn như lỗi kiểm tra trình tự hoặc huỷ giao dịch.

Xem các nguyên tắc ở trên để quyết định giữa FAILED_PRECONDITION, ABORTEDUNAVAILABLE.

Liên kết HTTP: Xung đột 409

OUT_OF_RANGE

Thao tác đã được thực hiện ngoài phạm vi hợp lệ. Ví dụ: tìm kiếm hoặc đọc cuối tệp.

Không giống như INVALID_ARGUMENT, lỗi này cho biết sự cố có thể được khắc phục nếu trạng thái hệ thống thay đổi. Ví dụ: hệ thống tệp 32 bit sẽ tạo INVALID_ARGUMENT nếu được yêu cầu đọc ở độ lệch không nằm trong phạm vi [0,2^32-1], nhưng hệ thống sẽ tạo OUT_OF_RANGE nếu được yêu cầu đọc từ độ lệch quá kích thước tệp hiện tại.

Có một chút trùng lặp giữa FAILED_PRECONDITIONOUT_OF_RANGE. Bạn nên sử dụng OUT_OF_RANGE (lỗi cụ thể hơn) khi áp dụng để người gọi lặp lại không gian có thể dễ dàng tìm lỗi OUT_OF_RANGE để phát hiện khi họ hoàn tất.

Liên kết HTTP: 400 yêu cầu không hợp lệ

UNIMPLEMENTED

Thao tác này không được triển khai hoặc không được hỗ trợ/bật trong dịch vụ này.

Liên kết HTTP: 501 chưa được triển khai

INTERNAL

Lỗi nội bộ. Điều này có nghĩa là một số biến thể dự kiến do hệ thống cơ bản dự kiến đã bị hỏng. Mã lỗi này được dành riêng cho các lỗi nghiêm trọng.

Liên kết HTTP: Lỗi máy chủ nội bộ 500

UNAVAILABLE

Dịch vụ này hiện không dùng được. Đây rất có thể là một tình trạng tạm thời. Điều kiện này có thể khắc phục bằng cách thử lại với thời gian đợi. Lưu ý rằng không phải lúc nào bạn cũng có thể thử lại các thao tác không đúng cách.

Xem các nguyên tắc ở trên để quyết định giữa FAILED_PRECONDITION, ABORTEDUNAVAILABLE.

Liên kết HTTP: Dịch vụ 503 không hoạt động

DATA_LOSS

Lỗi dữ liệu không thể khôi phục hoặc bị hỏng.

Liên kết HTTP: Lỗi máy chủ nội bộ 500