Ошибки
Если операция выполнена успешно, сервер возвращает клиенту статус OK с кодом 0. В случае возникновения ошибки — сервер отвечает соответствующим сообщением об ошибке.
Для стандартизации ошибок в API используется структура google.rpc.Status.
Ниже представлен перечень поддерживаемых ошибок. Более подробную информацию, включая .proto-спецификацию, можно найти в google.rpc.Code.
Формат ошибки
Сообщение Status включает в себя три поля:
| Поле | Описание |
|---|---|
| code | Код ошибки int32. Поддерживаемые значения определены в google.rpc.Code. |
| message | Текстовое описание ошибки. |
| details | Содержащее дополнительную информацию об ошибке — например, с указанием некорректных параметров. |
Список ошибок
| gRPC-код | gRPC-статус | Описание ошибки |
|---|---|---|
| 1 | CANCELLED | Операция была прервана клиентом. |
| 2 | UNKNOWN | Неизвестная ошибка произошла на стороне сервера. |
| 3 | INVALID_ARGUMENT | Запрос содержит некорректные параметры. Подробности доступны в поле details. |
| 4 | DEADLINE_EXCEEDED | Превышено время ожидания ответа от сервера. |
| 7 | PERMISSION_DENIED | У клиента недостаточно прав для выполнения операции. |
| 8 | RESOURCE_EXHAUSTED |
|
| 10 | ABORTED | Обработка запроса прекращена со стороны сервера при релизах сервиса. |
| 12 | NOT_IMPLEMENTED | Запрошенная операция не реализована в текущей версии сервиса. |
| 13 | INTERNAL | Внутренняя ошибка сервера. |
| 14 | UNAVAILABLE | Сервис временно недоступен. Рекомендуется повторить запрос позже. |
| 16 | UNAUTHENTICATED | Операция требует аутентификации. Клиент не предоставил корректные учетные данные. Подробная инструкция. |