Penjelasan kode kesalahan APIs Peta Spasial Sparse
Format respons
Semua respons API menggunakan format JSON yang seragam, berikut adalah contohnya:
{
"statusCode": 119,
"msg": "Parameter has errors",
"date": "2022-06-15T09:56:30.000Z",
"result": //Field result hanya ada jika statusCode adalah 0. Jika terjadi kesalahan, field result kosong
}
| Field | Tipe | Penjelasan |
|---|---|---|
| statusCode | integer | Kode status bisnis, 0 menunjukkan sukses, bukan 0 menunjukkan kesalahan |
| msg | string | Pesan |
| result | object | Konten respons. Saat kode status 0, berisi struktur objek peta target. Jika tidak, kosong |
| date | string | Waktu server |
Penting
Hanya jika statusCode == 0, result berisi konten respons. Pada status lain, result kosong
Jika statusCode != 0, perhatikan pesan kesalahan msg
Klasifikasi kode kesalahan
Penjelasan kode status HTTP
| Kode status HTTP | Penjelasan |
|---|---|
| 200 | Permintaan berhasil (mungkin mengandung kesalahan bisnis) |
| 400 | Kesalahan parameter permintaan |
| 401 | Autentikasi APIKey gagal |
| 403 | Izin tidak cukup atau akses sumber daya dilarang |
| 404 | Path URL permintaan tidak ada |
| 500 | Kesalahan internal server |
| 502 | Aplikasi menangkap pengecualian, kemungkinan kesalahan data |
Perhatian: Kesalahan bisnis biasanya dikembalikan melalui respons HTTP 200, diidentifikasi dalam field statusCode.
Daftar kode status bisnis
| Status Code | Pesan |
|---|---|
| 0 | Success |
| 101 | File yang diunggah kosong |
| 102 | Ukuran file terlalu besar |
| 106 | Parameter hilang atau parameter kosong |
| 110 | Kesalahan memanggil API server |
| 111 | Sumber daya tidak ditemukan |
| 401 | Token autentikasi kedaluwarsa |
| 401 | Parameter autentikasi hilang |
| 401 | appId atau appKey tidak dikenal |
| 401 | Akun terkunci |
| 401 | Autentikasi gagal, tanda tangan atau token tidak valid |
Skenario kesalahan umum
Tidak ada respons karena waktu habis
- Request Timeout: Jaringan agak lambat, disarankan memeriksa lingkungan jaringan klien
Kesalahan terkait autentikasi
- Http 401 Unauthorized: Autentikasi APIKey gagal, periksa apakah appId/appKey benar
- Kode status 401: Kunci aplikasi tidak valid atau aplikasi tidak ada, periksa konfigurasi aplikasi
Kesalahan parameter
- 400 Bad Request: Format parameter permintaan salah
Kesalahan operasi sumber daya
- Kode status 10x: Sumber daya target yang dicari tidak ada, atau parameter salah
Kesalahan sistem
- Http 50x Internal Server Error: Pengecualian internal server atau aplikasi menangkap pengecualian, disarankan menguji di situs web atau menggunakan sampel uji
Saran praktik terbaik
- Penanganan klien: Disarankan menilai keberhasilan bisnis berdasarkan field
statusCode, bukan hanya mengandalkan kode status HTTP - Percobaan ulang kesalahan: Untuk kesalahan 5xx dapat dicoba ulang secara wajar, untuk kesalahan 4xx periksa parameter permintaan
- Pencatatan log: Disarankan mencatat respons kesalahan lengkap untuk memudahkan pemecahan masalah
- Penanganan waktu habis: Tetapkan waktu tunggu permintaan yang wajar untuk menghindari penantian lama