Descripción de códigos de error de APIs de sparse spatial map

Formato de respuesta

Todas las respuestas de API usan un formato JSON unificado. El siguiente es un ejemplo:

{

  "statusCode": 119,

  "msg": "Parameter has errors",

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

  "result":  //result solo existe cuando statusCode es 0; si se produce un error, el campo de resultado queda vacio

}

Campo	Tipo	Descripción
statusCode	integer	Código de estado de negocio. 0 indica éxito, distinto de 0 indica error
msg	string	Mensaje
result	object	Contenido devuelto. Cuando el status code es 0, responde con la estructura del objeto target image; de lo contrario está vacío
date	string	Hora del servidor

Importante

result incluye contenido de respuesta solo cuando statusCode == 0. En otros estados, result está vacío
Cuando statusCode != 0, preste atención al mensaje de error msg

Categorías de códigos de error

Descripción de HTTP status code

HTTP status code	Descripción
200	Solicitud correcta (puede contener errores de negocio)
400	Error de parámetros de solicitud
401	Fallo de autenticación APIKey
403	Permisos insuficientes o acceso al recurso prohibido
404	El Path de la API de la URL solicitada no existe
500	Error interno del servidor
502	Excepción de aplicación capturada, posible error de datos

Atención: los errores de negocio suelen devolverse mediante una respuesta HTTP 200, y el tipo de error concreto se identifica en el 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

Escenarios de error comunes

Timeout sin respuesta

Request Timeout: la red es relativamente lenta. Se recomienda comprobar el entorno de red del cliente

Errores relacionados con autenticación

Http 401 Unauthorized: Fallo de autenticación APIKey. Compruebe si appId/appKey son correctos
Status code 401: la clave de aplicación no es válida o la aplicación no existe. Compruebe la configuración de la aplicación

Errores de parámetros

400 Bad Request: error de formato de parámetros de solicitud

Errores de operación de recursos

Status code 10x: el recurso target consultado no existe, o los parámetros son incorrectos

Errores del sistema

Http 50x Internal Server Error: excepción interna del servidor o excepción de aplicación capturada. Se recomienda probar en el sitio web o con sample

Recomendaciones de mejores prácticas

Manejo del cliente: se recomienda determinar si la operación de negocio tuvo éxito según el campo statusCode, en lugar de depender solo de HTTP status code
Reintento de errores: para errores 5xx puede reintentar según corresponda; para errores 4xx debe comprobar los parámetros de solicitud
Registro de logs: se recomienda registrar la respuesta de error completa para facilitar la solución de problemas
Manejo de timeout: configure un tiempo de espera de solicitud razonable para evitar esperas prolongadas

Table of Contents