Status
Тип Status
определяет логическую модель ошибок, подходящую для различных сред программирования, включая API REST и API RPC. Он используется gRPC . Каждое сообщение Status
содержит три части данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Подробнее об этой модели ошибок и о том, как с ней работать, можно узнать в API Design Guide .
JSON-представление |
---|
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
Поля |
---|
code | integer Код состояния, который должен быть значением перечисления google.rpc.Code . |
message | string Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке, обращенное к пользователю, должно быть локализовано и отправлено в поле google.rpc.Status.details или локализовано клиентом. |
details[] | object Список сообщений, содержащих сведения об ошибке. Существует общий набор типов сообщений для использования API. Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } . |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-13 UTC.
[null,null,["Последнее обновление: 2024-11-13 UTC."],[[["The `Status` type is a structured approach to define errors in APIs, containing an error code, message, and details for analysis."],["The error model utilizes a JSON representation with fields for code, message, and an array for detailed error information."],["Developers can integrate this model into REST APIs and RPC APIs, referencing the `google.rpc.Code` enum for standardized error codes."],["Error messages are intended for developers and should be in English, while user-facing messages should be handled separately via localization."],["The `details` field provides flexibility by allowing arbitrary objects to convey specific error information using a URI for type identification."]]],[]]