Mã lỗi chính tắc cho các API gRPC.
Đôi khi có thể áp dụng nhiều mã lỗi. Các 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 bạn áp dụng cả hai mã. Tương tự, thích NOT_FOUND
hoặc ALREADY_EXISTS
hơn FAILED_PRECONDITION
.
Enum | |
---|---|
OK |
Không phải là lỗi; trả về khi thành công. Ánh xạ HTTP: 200 OK |
CANCELLED |
Thao tác đã bị hủy, thường là do người gọi. Bản đồ HTTP: 499 Yêu cầu đã đóng của ứng dụng khách |
UNKNOWN |
Lỗi không xác định. Ví dụ: hệ thống có thể trả về lỗi này khi một giá trị Bản đồ HTTP: Lỗi Máy chủ Nội bộ 500 |
INVALID_ARGUMENT |
Ứng dụng chỉ định một đối số không hợp lệ. Xin lưu ý rằng giá trị này khác với Ánh xạ HTTP: 400 Yêu cầu Không hợp lệ |
DEADLINE_EXCEEDED |
Thời hạn đã hết trước khi thao tác có thể hoàn tất. Đối với các thao tác thay đổi trạng thái của hệ thống, lỗi này có thể được trả về ngay cả khi thao tác đó đã 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. Ánh xạ HTTP: Hết thời gian chờ 504 cổng |
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 các 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ộ lớp người dùng, chẳng hạn như triển khai tính năng dần dần hoặc danh sách cho phép không có trong tài liệu, thì có thể sử dụng Ánh xạ HTTP: 404 Không tìm thấy |
ALREADY_EXISTS |
Đối tượng mà ứng dụng khách đã cố tạo (ví dụ: tệp hoặc thư mục) đã tồn tại. Ánh xạ 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 sử dụng Ánh xạ HTTP: 403 Forbidden |
UNAUTHENTICATED |
Yêu cầu không có thông tin xác thực hợp lệ cho thao tác này. Ánh xạ HTTP: 401 Không được 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ể toàn bộ hệ thống tệp đã hết dung lượng. Ánh xạ HTTP: 429 Quá nhiều yêu cầu |
FAILED_PRECONDITION |
Thao tác bị từ chối vì hệ thống không ở trạng thái bắt buộc để thực thi thao tác. Ví dụ: thư mục cần xóa không được để trống, thao tác rmdir được áp dụng cho thư mục không phải thư mục, v.v. Trình triển khai dịch vụ có thể sử dụng các nguyên tắc sau để quyết định giữa Ánh xạ HTTP: 400 Yêu cầu Không hợp lệ |
ABORTED |
Thao tác này đã bị huỷ bỏ, thường là do một vấn đề đồng thời, chẳng hạn như lỗi kiểm tra trình tự hoặc hủy giao dịch. Xem các nguyên tắc ở trên để quyết định giữa Ánh xạ HTTP: Xung đột 409 |
OUT_OF_RANGE |
Thao tác đã được thử quá phạm vi hợp lệ. Ví dụ: tìm hoặc đọc phần cuối của tệp. Không giống như Có một chút trùng lặp giữa Ánh xạ 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. Ánh xạ 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ố bất biế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. Bản đồ 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 thoáng qua, có thể được khắc phục bằng cách thử lại bằng thuật toán 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 xác định. Xem các nguyên tắc ở trên để quyết định giữa Bản đồ HTTP: 503 Dịch vụ không khả dụng |
DATA_LOSS |
Mất hoặc hỏng dữ liệu không thể phục hồi. Bản đồ HTTP: Lỗi Máy chủ Nội bộ 500 |