Các phần sau đây mô tả mô hình lỗi cho phương pháp tài nguyên v2 và v1, lần lượt.
mô hình lỗi tài nguyên v2
Mặc định, các phương pháp tài nguyên đáp ứng với tình trạng thái200 OK.Khi yêu cầu không thành công, Open Cloud trả lại mã lỗi tiêu chuẩn.Tất cả các phản hồi lỗi có cùng một định dạng, bao gồm:
- code - Đại diện cho mã trạng thái HTTP.
- message - Một tin nhắn giải thích lỗi.
- details - Một đối tượng chứa thêm thông tin cụ thể về lỗi.
Ví dụ lỗi
{
"code": "INVALID_ARGUMENT",
"message": "The provided filter is invalid.",
"details": [
{
...
}
]
}
Mã
Bảng sau đây mô tả các giá trị có thể cho code .
Mã | Tình trạng HTTP | Mô tả |
---|---|---|
INVALID_ARGUMENT | 400 | Bạn đã truyền một tham số không hợp lệ, chẳng hạn như một tham số không hợp lệ universeId . Bạn cũng có thể thiếu hoặc không hợp lệ các tiêu đề, chẳng hạn như Content-Length và Content-Type . |
PERMISSION_DENIED | 403 | Yêu cầu của bạn không có đủ quyền hoặc phạm vi để thực hiện hoạt động. |
NOT_FOUND | 404 | Hệ thống không thể tìm thấy tài nguyên được định cấu hình của bạn, chẳng hạn như một lượt truy cập vào kho dữ liệu. |
ABORTED | 409 | Hoạt động đã bị hủy. |
RESOURCE_EXHAUSTED | 429 | Bạn không có đủ quota để thực hiện hoạt động, thường là do gửi quá nhiều yêu cầu. |
CANCELLED | 499 | Hệ thống kết thúc yêu cầu, thường do thời gian chờ của phía khách hàng hết hạn. |
INTERNAL | 500 | Lỗi máy chủ nội bộ, thường do lỗi máy chủ. |
NOT_IMPLEMENTED | 501 | Máy chủ không thực hiện phương pháp API. |
UNAVAILABLE | 503 | Dịch vụ không khả dụng, thường được trả lại khi máy chủ bị xuống. |
mô hình lỗi tài nguyên v1
Tất cả các phản hồi lỗi có cùng một định dạng tiêu chuẩn, bao gồm:
- Một trường error cấp cao, là nguyên nhân áp dụng cho tất cả các điểm cuối Open Cloud.
- Một lỗi giải thích message, giải thích thêm lỗi.
- Một đối tượng errorDetails, bao gồm thêm thông tin về lỗi cụ thể cho mỗi API.
Để phân tích nguyên nhân gốc của một lỗi, hãy tham khảo giá trị của trường error và trường errorDetails.Sử dụng trường message như một phần bổ sung cho xử lý lỗi, vì đôi khi nó có thể không bao gồm cùng mức chi tiết như trường errorDetails .
Ví dụ phản hồi lỗi của Cơ sở dữ liệu tiêu chuẩn
{
"error": "INVALID_ARGUMENT",
"message": "Invalid cursor.",
"errorDetails": [
{
"errorDetailType": "DatastoreErrorInfo",
"datastoreErrorCode": "InvalidCursor"
}
]
}
Phản hồi lỗi ví dụ hiển thị Open Cloud cấp cao error như INVALID_ARGUMENT , lỗi message như InvalidCursor , và errorDetails cụ thể cho lưu trữ dữ liệu với datastoreErrorCode như InvalidCursor .Từ các trường error và datastoreErrorCode của phản hồi, bạn có thể hiểu rằng bạn đã truyền một tham số con trỏ không hợp lệ gây ra lỗi.Bạn có thể chỉnh sửa tham số con trỏ của bạn để giải quyết vấn đề.
Tất cả các đáp ứng lỗi dữ liệu được yêu cầu đều có cùng một định dạng, bao gồm:
Ví dụ phản hồi lỗi của Cửa hàng dữ liệu được xếp hạng
{
"code": "INVALID_ARGUMENT",
"message": "Invalid cursor."
}
The code sẽ chứa một chuỗi lỗi cấp cao trong khi message sẽ chứa chi tiết cụ thể liên quan đến lỗi
Mã
Tham khảo bảng sau đây để có tổng quát tất cả các lỗi cấp cao của Đám mây Mở.
Mã trạng thái HTTP | Lỗi | Mô tả |
---|---|---|
400 | KHÔNG HỢP LỆ_ARGUMENT | Bạn đã truyền một tham số không hợp lệ, chẳng hạn như một tham số không hợp lệ universeId . Bạn cũng có thể thiếu hoặc không hợp lệ các tiêu đề, chẳng hạn như Content-Length và Content-Type . |
403 | KHÔNG ĐỦ_SCOPE | Yêu cầu yêu cầu quyền cao hơn so với quyền được cung cấp bởi token truy cập. |
403 | QUYỀN_TỪ CHỐI | Yêu cầu của bạn không có đủ phạm vi để thực hiện hoạt động. |
404 | KHÔNG_TÌM_THẤY | Hệ thống không thể tìm thấy tài nguyên được định cấu hình của bạn, chẳng hạn như một kho lưu trữ dữ cửa hàng. |
409 | BỊ HỦY | Hoạt động đã bị hủy do xung đột, chẳng hạn như xuất bản một nơi không thuộc vũ trụ. |
429 | TÀI NGUYÊN_MỆT MỎI | Bạn không có đủ quota để thực hiện hoạt động, thường là do gửi quá nhiều yêu cầu. |
499 | BỊ HUỶ | Hệ thống kết thúc yêu cầu, thường do thời gian chờ của phía khách hàng hết hạn. |
500 | NỘI BỘ | Lỗi máy chủ nội bộ. Thông thường là lỗi máy chủ. |
501 | KHÔNG_ÁP DỤNG | Máy chủ không thực hiện phương pháp API. |
503 | KHÔNG CÓ SẴN | Dịch vụ không có sẵn. Thông thường, máy chủ đang bị xuống. |