Cloud recognition apis código de error explicación

Formato de respuesta

Todas las respuestas de API adoptan un formato JSON unificado, aquí hay un ejemplo:

{

  "statusCode": 422,

  "reuslt": "The image or meta exceeds its maximum permitted size",

  "timestamp": 1514736000000,

  "appKey": "test_app_key"

}

Campo	Tipo	Descripción
statusCode	integer	Código de estado del negocio, 0 indica éxito, distinto de 0 indica error
result	string	Contenido de retorno. Cuando el código de estado es 0, responde con la estructura del objeto de imagen objetivo; de lo contrario, devuelve un mensaje de error
timestamp	long	Marca de tiempo Unix del servidor (en milisegundos)

Importante

Bajo la condición statusCode == 0, result incluye el contenido de respuesta; en otros estados, result devuelve mensajes de error.

Clasificación de códigos de error

Explicación del código de estado HTTP

Código de estado HTTP	Descripción
200	Solicitud exitosa (puede contener errores de negocio)
400	Error en los 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 interfaz solicitada no existe
500	Error interno del servidor
501	Excepción de aplicación capturada, posible error de datos
502	Servidor no disponible, contacte al servicio al cliente

Nota

Los errores de negocio generalmente se devuelven a través de la respuesta HTTP 200, identificados en el campo statusCode.

Tabla de códigos de estado de negocio

Status Code	Mensaje
0	ok
1	invalid appId (appKey)
2	invalid signature
3	invalid date
4	appId (appKey) not exist
6	invalid token
6	invalid appkey token
7	non-sdk client for dau databases
8	Dau databases are not compatible with sense-4.6+ any more.
404	Target not found
414	Parameter required not exists or not correct
422	The image or meta exceeds its maximum permitted size
417	fail to add image
419	Cannot update target in database because similar target exists.
420	Target delete failed
424	Target enable error
403	Target already exists
426	Judge exceeds maxium candidates
427	Image not correct

Escenarios de error comunes

Sin respuesta por tiempo de espera

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 no existe, verifique la configuración de la aplicación.

Errores de parámetros

400 Bad Request: Formato de parámetros de solicitud incorrecto.
Código de estado 414: Falta parámetro obligatorio o el valor del parámetro no cumple con los requisitos.

Errores de operación de recursos

Código de estado 404: El recurso objetivo consultado no existe.
Código de estado 403: El objetivo ya existe, no se puede crear repetidamente.
Código de estado 417/420/424: Falló la operación de agregar, eliminar o modificar.

Errores relacionados con archivos

Código de estado 422: El tamaño del archivo cargado excede el límite.
Código de estado 427: Formato de imagen no compatible o archivo dañado.

Errores del sistema

Http 500 Internal Server Error: Excepción interna del servidor, se recomienda probar en el sitio web o con sample.
Http 501 Exception: Excepción de aplicación capturada, posible error de datos, pruebe en el sitio web o con sample.
Http 502 Server: Error de respuesta del servicio, posible error del servidor, contáctenos.

Mejores prácticas sugeridas

Procesamiento del cliente: Se recomienda juzgar si el negocio es exitoso según el campo statusCode, no solo depender del código de estado HTTP.
Reintento de errores: Para errores 5xx se puede reintentar adecuadamente; para errores 4xx es necesario verificar los parámetros de solicitud.
Registro de registros: Se recomienda registrar la respuesta de error completa para facilitar la solución de problemas.
Manejo de tiempo de espera: Establezca un tiempo de espera de solicitud razonable para evitar esperas prolongadas.

Table of Contents