Kesalahan

Bagian berikut menjelaskan penanganan kesalahan untuk Open Cloud APIs. Karena perbedaan implementasi di berbagai endpoint dan lapisan validasi, respons kesalahan dapat bervariasi secara signifikan dalam formatnya.

Kesalahan Gerbang

Untuk masalah autentikasi atau routing, baik API Open Cloud v1 maupun v2 dapat mengembalikan kesalahan dalam format ini:

Contoh kesalahan gerbang
{
  "errors": [
    {
      "code": 0,
      "message": "Kunci API tidak valid"
    }
  ]
}

Open Cloud v2

API Open Cloud v2 umumnya mengikuti format kesalahan yang konsisten ketika kesalahan terjadi di dalam endpoint API itu sendiri.

Format kesalahan standar v2

API Open Cloud v2 mengembalikan kesalahan dalam format ini:

• code - Sebuah string yang mewakili tipe kesalahan (contoh: INVALID_ARGUMENT, NOT_FOUND).
• message - Pesan yang dapat dibaca manusia yang menjelaskan kesalahan.
• details - Sebuah array opsional yang berisi informasi tambahan yang spesifik untuk kesalahan.

Contoh kesalahan v2
{
  "code": "INVALID_ARGUMENT",
  "message": "ID Pengguna tidak valid dalam permintaan."
}

Contoh kesalahan v2 dengan detail
{
  "code": "INVALID_ARGUMENT",
  "message": "Filter yang diberikan tidak valid.",
  "details": [
    {
      ...
    }
  ]
}

Kode kesalahan v2

Tabel berikut menjelaskan kemungkinan nilai untuk code dalam respons API v2.

Open Cloud v1

API Open Cloud v1 memiliki format respons kesalahan yang tidak konsisten. Format tersebut tergantung pada endpoint spesifik, jenis kesalahan, dan tempat kesalahan terjadi dalam alur pemrosesan permintaan.

Sebagian besar endpoint v1 mengembalikan kesalahan dalam salah satu dari tiga format berikut:

Contoh kesalahan v1 dengan field error
{
  "error": "INVALID_ARGUMENT",
  "message": "Cursor tidak valid.",
  "errorDetails": [
    {
      "errorDetailType": "DatastoreErrorInfo",
      "datastoreErrorCode": "InvalidCursor"
    }
  ]
}

Contoh kesalahan v1 dengan field code
{
  "code": "INVALID_ARGUMENT",
  "message": "Cursor tidak valid."
}

Contoh kesalahan validasi v1 yang mendetail
{
  "errors": {
    "assetId": ["Nilai 'a' tidak valid."]
  },
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "Satu atau lebih kesalahan validasi terjadi.",
  "status": 400,
  "extensions": {
    "traceId": "00-427917f0fc3b8375ee33e4603a7f0693-f3f6ad560ff1a122-00"
  }
}

Kode kesalahan v1

Tabel berikut menjelaskan kemungkinan nilai untuk error atau code dalam respons API v1: