Sparse space map APIs error code description
Response format
Todas las respuestas de API utilizan un formato JSON unificado. A continuación se muestra un ejemplo:
{
"statusCode": 119,
"msg": "Parameter has errors",
"date": "2022-06-15T09:56:30.000Z",
"result": //statusCode es 0 cuando hay result. Si hay error, result está vacío
}
| Campo | Tipo | Descripción |
|---|---|---|
| statusCode | integer | Código de estado del negocio. 0 indica éxito, no-0 indica error |
| msg | string | Mensaje |
| result | object | Contenido de respuesta. Cuando statusCode es 0, contiene la estructura del objeto de mapa objetivo; de lo contrario, está vacío |
| date | string | Hora del servidor |
Importante
Solo cuando statusCode == 0, result incluye contenido de respuesta. En otros estados, result está vacío.
Cuando statusCode != 0, preste atención al mensaje de error msg.
Clasificación de códigos de error
Explicación de códigos de estado HTTP
| Código de estado HTTP | Descripción |
|---|---|
| 200 | Solicitud exitosa (puede contener errores de negocio) |
| 400 | Error en parámetros de solicitud |
| 401 | Fallo de autenticación de APIKey |
| 403 | Permisos insuficientes o acceso prohibido al recurso |
| 404 | La ruta URL de la API solicitada no existe |
| 500 | Error interno del servidor |
| 502 | Excepción capturada en la aplicación, posible error de datos |
Nota: Los errores de negocio generalmente se devuelven a través de una respuesta HTTP 200, identificados en el campo statusCode.
Tabla de códigos de estado de negocio
| 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
Tiempo de espera sin respuesta
- Request Timeout: La red es lenta. Se recomienda verificar el entorno de red del cliente.
Errores relacionados con autenticación
- Http 401 Unauthorized: Fallo de autenticación de APIKey. Verifique si appId/appKey es correcto.
- Código de estado 401: Clave de aplicación inválida o aplicación inexistente. Verifique la configuración de la aplicación.
Errores de parámetros
- 400 Bad Request: Formato de parámetros de solicitud incorrecto.
Errores de operación de recursos
- Código de estado 10x: El recurso objetivo de consulta no existe o hay errores en los parámetros.
Errores del sistema
- Http 50x Internal Server Error: Excepción interna del servidor o excepción capturada en la aplicación. Se recomienda probar en el sitio web o con una muestra.
Mejores prácticas recomendadas
- Manejo del cliente: Se recomienda juzgar el éxito del negocio según el campo
statusCode, no solo depender del código de estado HTTP. - Reintentos de errores: Para errores 5xx, se puede reintentar adecuadamente. Para errores 4xx, verifique 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 tiempos de espera: Establezca un tiempo de espera de solicitud razonable para evitar esperas prolongadas.