Descrição dos códigos de erro das APIs sparse spatial map

Formato de resposta

Todas as respostas de API usam um formato JSON unificado. Veja um exemplo:

{

  "statusCode": 119,

  "msg": "Parameter has errors",

  "date": "2022-06-15T09:56:30.000Z",

  "result":  //result existe apenas quando statusCode e 0; se ocorrer um erro, o campo de resultado fica vazio

}

Campo	Tipo	Descrição
statusCode	integer	Código de status de negócio. 0 indica sucesso, não 0 indica erro
msg	string	Mensagem
result	object	Conteúdo retornado. Quando o status code é 0, responde com a estrutura do objeto target image; caso contrário, fica vazio
date	string	Hora do servidor

Importante

result inclui conteúdo de resposta apenas quando statusCode == 0. Em outros estados, result fica vazio
Quando statusCode != 0, preste atenção à mensagem de erro msg

Categorias de códigos de erro

Descrição de HTTP status code

HTTP status code	Descrição
200	Solicitação bem-sucedida (pode conter erros de negócio)
400	Erro de parâmetros da solicitação
401	Falha na autenticação APIKey
403	Permissão insuficiente ou acesso ao recurso proibido
404	O Path da API da URL solicitada não existe
500	Erro interno do servidor
502	Exceção da aplicação capturada, possível erro de dados

Atenção: erros de negócio geralmente são retornados por meio de uma resposta HTTP 200, e o tipo específico de erro é identificado no campo statusCode.

Lista de business status code

Status Code	Message
0	Success
101	Uploaded file is empty
102	File size is too large
106	Missing parameter or parameter is empty
110	Call server API errors
111	Resource not found
401	Authentication token expired
401	Authentication parameter is missing
401	Unknown appId or appKey
401	Account is locked
401	Authentication failed, invalid signature or token

Cenários de erro comuns

Timeout sem resposta

Request Timeout: a rede está relativamente lenta. Recomenda-se verificar o ambiente de rede do cliente

Erros relacionados à autenticação

Http 401 Unauthorized: falha na autenticação APIKey. Verifique se appId/appKey estão corretos
Status code 401: chave da aplicação inválida ou aplicação inexistente. Verifique a configuração da aplicação

Erros de parâmetros

400 Bad Request: erro no formato dos parâmetros da solicitação

Erros de operação de recursos

Status code 10x: o recurso target consultado não existe, ou os parâmetros estão incorretos

Erros do sistema

Http 50x Internal Server Error: exceção interna do servidor ou exceção da aplicação capturada. Recomenda-se testar no site ou com sample

Recomendações de melhores práticas

Tratamento no cliente: recomenda-se determinar se a operação de negócio foi bem-sucedida de acordo com o campo statusCode, em vez de depender apenas de HTTP status code
Retry de erro: para erros 5xx, tente novamente conforme apropriado; para erros 4xx, verifique os parâmetros da solicitação
Registro de logs: recomenda-se registrar a resposta de erro completa para facilitar a solução de problemas
Tratamento de timeout: defina um tempo de timeout de solicitação razoável para evitar longas esperas

Table of Contents