Package google.rpc

Chỉ mục

BadRequest

Mô tả các lỗi vi phạm trong yêu cầu của ứng dụng. Loại lỗi này tập trung vào các khía cạnh cú pháp của yêu cầu.

Trường
field_violations[]

FieldViolation

Mô tả tất cả các lỗi vi phạm trong một yêu cầu của máy khách.

FieldViolation

Một loại thông báo dùng để mô tả một trường yêu cầu không hợp lệ.

Trường
field

string

Đường dẫn dẫn đến một trường trong nội dung yêu cầu. Giá trị này sẽ là một chuỗi các giá trị nhận dạng được phân tách bằng dấu chấm để xác định một trường vùng đệm giao thức.

Hãy cân nhắc thực hiện những bước sau:

message CreateContactRequest {
  message EmailAddress {
    enum Type {
      TYPE_UNSPECIFIED = 0;
      HOME = 1;
      WORK = 2;
    }

    optional string email = 1;
    repeated EmailType type = 2;
  }

  string full_name = 1;
  repeated EmailAddress email_addresses = 2;
}

Trong ví dụ này, trong proto field có thể nhận một trong các giá trị sau:

  • full_name cho lỗi vi phạm trong giá trị full_name
  • email_addresses[1].email cho một lỗi vi phạm trong trường email của tin nhắn email_addresses đầu tiên
  • email_addresses[3].type[2] cho lỗi vi phạm ở giá trị type thứ hai trong thông báo email_addresses thứ ba.

Trong JSON, các giá trị tương tự được biểu thị như sau:

  • fullName cho lỗi vi phạm trong giá trị fullName
  • emailAddresses[1].email cho một lỗi vi phạm trong trường email của tin nhắn emailAddresses đầu tiên
  • emailAddresses[3].type[2] cho lỗi vi phạm ở giá trị type thứ hai trong thông báo emailAddresses thứ ba.
description

string

Nội dung mô tả lý do khiến phần tử yêu cầu không hợp lệ.
reason

string

Lý do gây ra lỗi ở cấp trường. Đây là một giá trị hằng số xác định nguyên nhân gần nhất gây ra lỗi ở cấp trường. Giá trị này phải xác định duy nhất loại FieldViolation trong phạm vi của google.rpc.ErrorInfo.domain. Tên này chỉ được dài tối đa 63 ký tự và phải khớp với biểu thức chính quy [A-Z][A-Z0-9_]+[A-Z0-9], biểu thị UPPER_SNAKE_CASE.
localized_message

LocalizedMessage

Cung cấp thông báo lỗi đã bản địa hoá cho các lỗi ở cấp trường mà người dùng API có thể nhận được một cách an toàn.

Mã

Mã lỗi chuẩn cho các API gRPC.

Đôi khi, nhiều mã lỗi có thể áp dụng. Các dịch vụ phải 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 cả hai mã đều áp dụng. Tương tự, hãy ưu tiên NOT_FOUND hoặc ALREADY_EXISTS hơn FAILED_PRECONDITION.

Enum
OK

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

Ánh xạ HTTP: 200 OK
CANCELLED

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

Ánh xạ HTTP: 499 Ứng dụng đã đóng yêu cầu
UNKNOWN

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

Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ
INVALID_ARGUMENT

Ứng dụng khách chỉ định đối số không hợp lệ. Xin lưu ý rằng thuộc tính 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 bị lỗi).

Ánh xạ HTTP: 400 Yêu cầu không hợp lệ
DEADLINE_EXCEEDED

Đã hết thời hạn 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ột máy chủ có thể bị trì hoãn đủ lâu để thời hạn hết hiệu lực.

Ánh xạ HTTP: 504 Hết thời gian chờ của cổng nối
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 ý 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ư việc triển khai tính năng từng bước hoặc danh sách cho phép không có trong tài liệu, thì bạn có thể sử dụng NOT_FOUND. Nếu một số người dùng trong một nhóm người dùng bị từ chối yêu cầu, chẳng hạn như kiểm soát quyền truy cập dựa trên người dùng, thì bạn phải sử dụng PERMISSION_DENIED.

Ánh xạ HTTP: 404 Not Found
ALREADY_EXISTS

Đã tồn tại thực thể mà ứng dụng khách tìm cách tạo (ví dụ: tệp hoặc thư mục).

Ánh xạ HTTP: 409 Xung đột
PERMISSION_DENIED

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

Ánh xạ 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.

Ánh xạ HTTP: 401 Không được phép
RESOURCE_EXHAUSTED

Một số tài nguyên đã cạn kiệ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 cần thiết để thực hiện thao tác. Ví dụ: thư mục cần xoá không phải là thư mục trống, thao tác rmdir được áp dụng cho một thư mục không phải là 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, ABORTED và UNAVAILABLE: (a) Sử dụng UNAVAILABLE nếu máy khách chỉ có thể thử lại lệnh 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 một thao tác kiểm tra 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 một chuỗi đọc-sửa đổi-ghi. (c) Sử dụng FAILED_PRECONDITION nếu ứng dụng không được thử lại cho đến khi trạng thái hệ thống được sửa chữa rõ ràng. Ví dụ: nếu "rmdir" không thành công vì thư mục không trống, thì FAILED_PRECONDITION sẽ được trả về vì máy khách không được thử lại trừ phi các tệp bị xoá khỏi thư mục.

Ánh xạ HTTP: 400 Yêu cầu không hợp lệ
ABORTED

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

Hãy xem các nguyên tắc ở trên để quyết định giữa FAILED_PRECONDITION, ABORTED và UNAVAILABLE.

Ánh xạ HTTP: 409 Xung đột
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 quá cuối tệp.

Không giống như INVALID_ARGUMENT, lỗi này cho biết có một vấn đề 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 ở một độ lệch không nằm trong phạm vi [0, 2^32-1], nhưng sẽ tạo OUT_OF_RANGE nếu được yêu cầu đọc từ một độ lệch vượt quá kích thước tệp hiện tại.

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

Ánh xạ HTTP: 400 Yêu cầu không hợp lệ
UNIMPLEMENTED

Thao tác này chưa đượ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 triển khai
INTERNAL

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

Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ
UNAVAILABLE

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

Hãy xem các nguyên tắc ở trên để quyết định giữa FAILED_PRECONDITION, ABORTED và UNAVAILABLE.

Ánh xạ HTTP: 503 Không có dịch vụ
DATA_LOSS

Mất hoặc hư hỏng dữ liệu và không phục hồi được.

Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ

ErrorInfo

Mô tả nguyên nhân gây ra lỗi kèm theo thông tin chi tiết có cấu trúc.

Ví dụ về lỗi khi liên hệ với API "pubsub.googleapis.com" khi API này chưa được bật:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

Phản hồi này cho biết API pubsub.googleapis.com chưa được bật.

Ví dụ về lỗi được trả về khi cố gắng tạo một phiên bản Spanner ở một khu vực hết hàng:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
Trường
reason

string

Lý do xảy ra lỗi. Đây là một giá trị hằng số xác định nguyên nhân gần nhất gây ra lỗi. Lý do gây ra lỗi là duy nhất trong một miền lỗi cụ thể. Tên này chỉ được dài tối đa 63 ký tự và phải khớp với biểu thức chính quy [A-Z][A-Z0-9_]+[A-Z0-9], biểu thị UPPER_SNAKE_CASE.
domain

string

Nhóm logic mà "lý do" thuộc về. Miền lỗi thường là tên dịch vụ đã đăng ký của công cụ hoặc sản phẩm tạo ra lỗi. Ví dụ: "pubsub.googleapis.com". Nếu lỗi do một số cơ sở hạ tầng phổ biến tạo ra, thì miền lỗi phải là một giá trị duy nhất trên toàn cầu để xác định cơ sở hạ tầng đó. Đối với cơ sở hạ tầng API của Google, miền lỗi là "googleapis.com".
metadata

map<string, string>

Thông tin chi tiết có cấu trúc bổ sung về lỗi này.

Khoá phải khớp với biểu thức chính quy [a-z][a-zA-Z0-9-_]+ nhưng tốt nhất nên là lowerCamelCase. Ngoài ra, tên phải có độ dài tối đa là 64 ký tự. Khi xác định giá trị hiện tại của một hạn mức vượt quá, các đơn vị phải nằm trong khoá chứ không phải giá trị. Ví dụ: thay vì {"instanceLimit": "100/request"}, bạn nên trả về {"instanceLimitPerRequest": "100"} nếu ứng dụng khách vượt quá số lượng phiên bản có thể được tạo trong một yêu cầu (hàng loạt).

Trợ giúp

Cung cấp đường liên kết đến tài liệu hoặc để thực hiện một hành động ngoài băng tần.

Ví dụ: nếu một quy trình kiểm tra hạn mức không thành công và có lỗi cho biết dự án gọi chưa bật dịch vụ được truy cập, thì lỗi này có thể chứa một URL trỏ trực tiếp đến đúng vị trí trong bảng điều khiển dành cho nhà phát triển để chuyển đổi bit.

Trường

LocalizedMessage

Cung cấp một thông báo lỗi đã được bản địa hoá và an toàn để trả về cho người dùng, thông báo này có thể được đính kèm vào một lỗi RPC.

Trường
locale

string

Ngôn ngữ được dùng theo quy cách được xác định tại https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Ví dụ: "en-US", "fr-CH", "es-MX"
message

string

Thông báo lỗi được bản địa hoá theo ngôn ngữ ở trên.

RequestInfo

Chứa siêu dữ liệu về yêu cầu mà các ứng dụng có thể đính kèm khi gửi lỗi hoặc cung cấp các hình thức phản hồi khác.

Trường
request_id

string

Một chuỗi không rõ ràng mà chỉ dịch vụ tạo ra chuỗi đó mới diễn giải được. Ví dụ: bạn có thể dùng mã này để xác định các yêu cầu trong nhật ký của dịch vụ.
serving_data

string

Mọi dữ liệu được dùng để xử lý yêu cầu này. Ví dụ: một dấu vết ngăn xếp được mã hoá có thể được gửi lại cho nhà cung cấp dịch vụ để gỡ lỗi.

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, trong đó có API REST và API RPC. gRPC sử dụng loại 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 cụ thể 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ý mô hình này trong Hướng dẫn thiết kế API.

Trường
code

int32

Mã trạng thái, phải là giá trị enum của google.rpc.Code.
message

string

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 mà người dùng thấy đều phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng khách bản địa hoá.
details[]

Any

Danh sách các thông báo chứa thông tin cụ thể về lỗi. Có một nhóm gồm nhiều loại thông báo chung để API sử dụng.