Beschreibung der Fehlercodes für sparse spatial map APIs

Antwortformat

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

{

  "statusCode": 119,

  "msg": "Parameter has errors",

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

  "result":  //statusCode 为 0 的情况才有 result，如果发生错误，结果字段为空

}

Feld	Typ	Beschreibung
statusCode	integer	Business-Statuscode. 0 bedeutet Erfolg, ungleich 0 bedeutet Fehler
msg	string	Nachricht
result	object	Zurückgegebener Inhalt. Wenn der status code 0 ist, wird die Objektstruktur des target image zurückgegeben; andernfalls ist es leer
date	string	Serverzeit

Wichtig

result enthält nur dann Antwortinhalte, wenn statusCode == 0. In anderen Zuständen ist result leer
Wenn statusCode != 0, achten Sie auf die Fehlermeldung msg

Fehlercode-Kategorien

Beschreibung von HTTP status code

HTTP status code	Beschreibung
200	Anfrage erfolgreich (kann Business-Fehler enthalten)
400	Fehler in Anfrageparametern
401	APIKey-Authentifizierung fehlgeschlagen
403	Unzureichende Berechtigung oder Ressourcenzugriff verboten
404	API Path der Anfrage-URL existiert nicht
500	Interner Serverfehler
502	Anwendungsausnahme erfasst, möglicherweise Datenfehler

Hinweis: Business-Fehler werden normalerweise über eine HTTP 200-Antwort zurückgegeben; der konkrete Fehlertyp wird im Feld statusCode identifiziert.

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

Häufige Fehlerszenarien

Timeout ohne Antwort

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

Authentifizierungsbezogene Fehler

Http 401 Unauthorized: APIKey-Authentifizierung fehlgeschlagen. Prüfen Sie, ob appId/appKey korrekt sind
Status code 401: Der Anwendungsschlüssel ist ungültig oder die Anwendung existiert nicht. Prüfen Sie die Anwendungskonfiguration

Parameterfehler

400 Bad Request: Formatfehler der Anfrageparameter

Fehler bei Ressourcenoperationen

Status code 10x: Die abgefragte Zielressource existiert nicht oder die Parameter sind falsch

Systemfehler

Http 50x Internal Server Error: Interne Serverausnahme oder Anwendungsausnahme erfasst. Es wird empfohlen, auf der Website oder mit einem sample zu testen

Empfehlungen zu Best Practices

Client-Verarbeitung: Es wird empfohlen, anhand des Felds statusCode zu beurteilen, ob der Business-Vorgang erfolgreich war, anstatt sich nur auf HTTP status code zu verlassen
Fehlerwiederholung: Bei 5xx-Fehlern kann angemessen wiederholt werden; bei 4xx-Fehlern müssen die Anfrageparameter geprüft werden
Protokollierung: Es wird empfohlen, die vollständige Fehlerantwort aufzuzeichnen, um die Fehlersuche zu erleichtern
Timeout-Behandlung: Legen Sie eine angemessene Anfrage-Timeout-Zeit fest, um langes Warten zu vermeiden

Table of Contents