Índice
Status(mensagem)
Status
O tipo de Status define um modelo de erro lógico compatível com diversos ambientes de programação, incluindo as APIs REST e RPC, e é usado pelo gRPC. O modelo de erro foi desenvolvido para ser:
- simples de usar e entender para a maioria dos usuários;
- flexível o suficiente para atender às necessidades imprevistas.
Visão geral
A mensagem de Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro. O código do erro precisa ser um valor de enumeração google.rpc.Code, mas outros códigos de erro poderão ser aceitos, se necessário. A mensagem de erro é uma mensagem em inglês que ajuda o desenvolvedor a entender e resolver o erro. Se uma mensagem de erro localizada para o usuário for necessária, coloque-a nos detalhes do erro ou faça a localização no cliente. Os detalhes opcionais do erro podem conter informações arbitrárias sobre ele. Há um conjunto predefinido de tipos de detalhes de erro no pacote google.rpc para as condições de erros comuns.
Mapeamento de linguagem
A mensagem de Status é a representação lógica do modelo de erro, mas não está necessariamente no formato de transmissão real. Quando essa mensagem de Status é exposta em diferentes bibliotecas de cliente e protocolos de transmissão, ela pode ser mapeada de modo diferente. Por exemplo, talvez ela seja mapeada para algumas exceções em Java, mas com probabilidade maior para alguns códigos de erro em C.
Outros usos
O modelo de erro e a mensagem de Status podem ser usados em diversos ambientes, com ou sem APIs, para que o desenvolvedor tenha uma experiência consistente, independentemente do ambiente usado.
Os exemplos de uso desse modelo de erro incluem:
erros parciais. Para que os erros parciais de um serviço sejam retornados ao cliente, incorpore o
Statusna resposta normal para indicar os erros parciais.erros de fluxo de trabalho. Um fluxo de trabalho típico tem várias etapas. Cada etapa pode ter uma mensagem de
Statuspara relatar o erro.operações em lote. Se um cliente usa solicitação em lote e resposta em lote, use a mensagem de
Statusdiretamente dentro da resposta em lote, uma para cada sub-resposta de erro.operações assíncronas. Quando uma chamada à API incorpora resultados de operação assíncrona, o status dessas operações precisa ser representado diretamente usando a mensagem de
Status.registros. Quando alguns erros de API são armazenados em registros, a mensagem de
Statuspode ser usada diretamente após qualquer remoção necessária por motivos de segurança/privacidade.
| Campos | |
|---|---|
code |
Código de status, que precisa ser um valor de enumeração |
message |
Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro direcionada ao usuário precisa ser localizada e enviada no campo |
details[] |
Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem. |