Sparse space map APIs erreur codes explication

Réponse format

Tous API réponses utilisent uniforme JSON format, voici un exemple :

{

  "statusCode": 119,

  "msg": "Parameter has errors",

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

  "result":  //statusCode est 0 situation a result, si erreur, résultat champ est vide

}

Champ	Type	Description
statusCode	integer	Business status code, 0 signifie succès, non-0 signifie erreur
msg	string	Message
result	object	Retour contenu, status code est 0 réponse cible objet structure, sinon vide
date	string	Serveur temps

Important

statusCode == 0 condition, result inclut réponse contenu, autres états result est vide
statusCode != 0 condition, veuillez consulter erreur message msg

Erreur codes classification

HTTP status codes explication

HTTP status code	Description
200	Requête succès (peut contenir business erreur)
400	Requête paramètre erreur
401	APIKey authentification échec
403	Permission insuffisante ou ressource accès interdit
404	Requête URL interface Path n'existe pas
500	Serveur interne erreur
502	Application exception capture, possible données erreur

Note: Business erreurs généralement via HTTP 200 réponse retour, dans statusCode champ identifier spécifique erreur type.

Business status codes liste

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

Commun erreur scénarios

Timeout sans réponse

Request Timeout: Réseau relativement lent, recommandé vérifier client environnement réseau

Authentification liée erreurs

Http 401 Unauthorized: APIKey authentification échec, vérifier appId/appKey correct
Status code 401: Application secret invalide ou application n'existe pas, vérifier application configuration

Paramètre erreurs

400 Bad Request: Requête paramètre format erreur

Ressource opération erreurs

Status code 10x: Requête cible ressource n'existe pas, ou paramètre erreur

Système erreurs

Http 50x Internal Server Error: Serveur interne exception ou application exception capture, recommandé site web tester ou sample tester

Meilleures pratiques recommandations

Client traitement: Recommandé selon statusCode champ juger business si succès, plutôt que seulement dépendre HTTP status code
Erreur retry: Pour 5xx erreurs possible retenter, pour 4xx erreurs besoin vérifier requête paramètres
Logs enregistrement: Recommandé enregistrer complet erreur réponse, facilité problème dépannage
Timeout gestion: Définir raisonnable requête timeout temps, éviter long temps attente

Table of Contents