Descripción de códigos de error de Cloud recognition APIs

Formato de respuesta

Todas las respuestas de API usan un formato JSON unificado. A continuación se muestra un ejemplo:

{

  "statusCode": 422,

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

  "timestamp": 1514736000000,

  "appKey": "test_app_key"

}

Field	Type	Descripción
statusCode	integer	Business status code. 0 significa éxito, non-0 significa error
result	string	Contenido devuelto. Cuando status code es 0, la respuesta contiene la estructura de target image object; de lo contrario, se devuelve error message
timestamp	long	Server Unix timestamp en milisegundos

Importante

Solo cuando statusCode == 0 result incluye response content. En otros estados, result devuelve error message.

Categorías de error code

Descripción de HTTP status code

HTTP status code	Descripción
200	Request exitoso, puede contener business errors
400	Error de request parameter
401	APIKey authentication failed
403	Permission insuficiente o acceso a resource prohibido
404	El URL interface Path solicitado no existe
500	Server internal error
501	Application exception captured, posible data error
502	Server unavailable, contacte con customer service

Nota

Los business errors suelen devolverse mediante respuestas HTTP 200, y el tipo de error concreto se identifica en el campo statusCode.

Lista de business status code

Status Code	Message
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

Timeout sin respuesta

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

Errores relacionados con authentication

Http 401 Unauthorized: APIKey authentication failed. Compruebe si appId/appKey son correctos
Status code 401: application key no válida o application inexistente. Compruebe la configuración de application

Parameter errors

400 Bad Request: error de formato de request parameter
Status code 414: faltan parameters obligatorios o los valores de parameters no cumplen los requisitos

Errores de operación de resource

Status code 404: el target resource consultado no existe
Status code 403: el target ya existe y no puede crearse repetidamente
Status code 417/420/424: falló la operación add, delete o update

Errores relacionados con file

Status code 422: el tamaño del file subido supera el límite
Status code 427: el formato de image no es compatible o el file está dañado

System errors

Http 500 Internal Server Error: server internal exception. Se recomienda probar en el website o con sample
Http 501 Exception: application exception captured, posible data error. Se recomienda probar en el website o con sample
Http 502 Server: service response error, posible server error. Contáctenos

Sugerencias de best practice

Manejo en client: se recomienda determinar si el business tuvo éxito según el campo statusCode, en lugar de depender solo del HTTP status code
Error retry: reintente adecuadamente para errores 5xx, y compruebe request parameters para errores 4xx
Registro de log: se recomienda registrar la respuesta de error completa para facilitar troubleshooting
Manejo de timeout: establezca un request timeout razonable para evitar esperas prolongadas

Table of Contents