Status
O tipo Status
define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC (em inglês). Cada mensagem Status
contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.
É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.
Representação JSON |
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
Campos |
code |
integer
O código de status, que precisa ser um valor de enumeração de google.rpc.Code .
|
message |
string
Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details , ou localizada pelo cliente.
|
details[] |
object
Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem. Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-08-21 UTC.
[null,null,["Última atualização 2024-08-21 UTC."],[[["The `Status` type is a structured approach to representing errors in systems like REST APIs and RPC APIs, encompassing an error code, message, and details for comprehensive error handling."],["It's built upon a standard JSON structure with designated fields for 'code', 'message', and 'details', ensuring consistent error reporting across different platforms and programming environments."],["Developers can leverage the accompanying API Design Guide to delve deeper into using the `Status` type effectively and gain practical insights for its implementation."]]],[]]