Beschreibung der Fehlercodes von Cloud recognition APIs

Antwortformat

Alle API-Antworten verwenden ein einheitliches JSON-Format. Das folgende Beispiel zeigt dies:

{

  "statusCode": 422,

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

  "timestamp": 1514736000000,

  "appKey": "test_app_key"

}

Field	Type	Beschreibung
statusCode	integer	Business status code. 0 bedeutet Erfolg, non-0 bedeutet Fehler
result	string	Zurückgegebener Inhalt. Wenn status code 0 ist, enthält die Antwort die target image object-Struktur, andernfalls wird eine error message zurückgegeben
timestamp	long	Server Unix timestamp in Millisekunden

Wichtig

Nur wenn statusCode == 0 ist, enthält result response content. In anderen Zuständen gibt result eine error message zurück.

Error code-Kategorien

Beschreibung von HTTP status code

HTTP status code	Beschreibung
200	Request erfolgreich, kann business errors enthalten
400	Request parameter-Fehler
401	APIKey authentication failed
403	Unzureichende permission oder resource-Zugriff verboten
404	Angeforderter URL interface Path existiert nicht
500	Server internal error
501	Application exception captured, möglicherweise data error
502	Server unavailable, customer service kontaktieren

Anmerkung

Business errors werden normalerweise über HTTP 200 responses zurückgegeben, und der konkrete Fehlertyp wird im Feld statusCode angegeben.

Liste der 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

Häufige Fehlerszenarien

Timeout ohne Antwort

Request Timeout: Das Netzwerk ist relativ langsam. Es wird empfohlen, die Netzwerkumgebung des client zu prüfen

Authentication-bezogene Fehler

Http 401 Unauthorized: APIKey authentication failed. Prüfen Sie, ob appId/appKey korrekt sind
Status code 401: application key ungültig oder application existiert nicht. Prüfen Sie die application configuration

Parameter errors

400 Bad Request: Fehler im Format des request parameter
Status code 414: Erforderliche parameters fehlen oder parameter values erfüllen die Anforderungen nicht

Resource operation-Fehler

Status code 404: Der abgefragte target resource existiert nicht
Status code 403: Das target existiert bereits und kann nicht erneut erstellt werden
Status code 417/420/424: Add-, delete- oder update-Operation fehlgeschlagen

File-bezogene Fehler

Status code 422: Die Größe der hochgeladenen file überschreitet das Limit
Status code 427: Das image-Format wird nicht unterstützt oder die file ist beschädigt

System errors

Http 500 Internal Server Error: server internal exception. Es wird empfohlen, auf der website oder mit sample zu testen
Http 501 Exception: application exception captured, möglicherweise data error. Es wird empfohlen, auf der website oder mit sample zu testen
Http 502 Server: service response error, möglicherweise server error. Bitte kontaktieren Sie uns

Best practice-Empfehlungen

Client-Verarbeitung: Es wird empfohlen, den business-Erfolg anhand des Feldes statusCode zu beurteilen, statt nur vom HTTP status code abhängig zu sein
Error retry: Bei 5xx-Fehlern angemessen retry durchführen, bei 4xx-Fehlern request parameters prüfen
Log-Aufzeichnung: Es wird empfohlen, die vollständige error response für troubleshooting aufzuzeichnen
Timeout-Behandlung: Einen angemessenen request timeout festlegen, um lange Wartezeiten zu vermeiden

Table of Contents