Błędy

Następujące sekcje opisują obsługę błędów dla API Open Cloud. Z powodu różnic w implementacji pomiędzy punktami końcowymi a warstwami walidacji, odpowiedzi błędów mogą znacznie różnić się formatem.

Błędy bramki

W przypadku problemów z autoryzacją lub routowaniem, zarówno API Open Cloud v1, jak i v2 mogą zwracać błędy w tym formacie:

Przykład błędu bramki
{
  "errors": [
    {
      "code": 0,
      "message": "Nieprawidłowy klucz API"
    }
  ]
}

Open Cloud v2

API Open Cloud v2 zazwyczaj stosują jednolity format błędów, gdy błąd występuje wewnątrz samego punktu końcowego API.

Standardowy format błędu v2

API Open Cloud v2 zwracają błędy w tym formacie:

• code - Ciąg reprezentujący typ błędu (np. INVALID_ARGUMENT, NOT_FOUND).
• message - Czytelny dla człowieka komunikat wyjaśniający błąd.
• details - Opcjonalna tablica zawierająca dodatkowe informacje specyficzne dla błędu.

Przykład błędu v2
{
  "code": "INVALID_ARGUMENT",
  "message": "Nieprawidłowe ID użytkownika w żądaniu."
}

Przykład błędu v2 z szczegółami
{
  "code": "INVALID_ARGUMENT",
  "message": "Podany filtr jest nieprawidłowy.",
  "details": [
    {
      ...
    }
  ]
}

Kody błędów v2

Poniższa tabela opisuje możliwe wartości dla code w odpowiedziach API v2.

Open Cloud v1

API Open Cloud v1 mają niespójne formaty odpowiedzi błędów. Format zależy od konkretnego punktu końcowego, rodzaju błędu i miejsca, w którym błąd występuje w potoku przetwarzania żądania.

Większość punktów końcowych v1 zwraca błędy w jednym z tych trzech formatów:

Przykład błędu v1 z polem błędu
{
  "error": "INVALID_ARGUMENT",
  "message": "Nieprawidłowy kursor.",
  "errorDetails": [
    {
      "errorDetailType": "DatastoreErrorInfo",
      "datastoreErrorCode": "InvalidCursor"
    }
  ]
}

Przykład błędu v1 z polem kodu
{
  "code": "INVALID_ARGUMENT",
  "message": "Nieprawidłowy kursor."
}

Przykład szczegółowego błędu walidacji v1
{
  "errors": {
    "assetId": ["Wartość 'a' jest nieprawidłowa."]
  },
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "Wystąpił jeden lub więcej błędów walidacji.",
  "status": 400,
  "extensions": {
    "traceId": "00-427917f0fc3b8375ee33e4603a7f0693-f3f6ad560ff1a122-00"
  }
}

Kody błędów v1

Poniższa tabela opisuje możliwe wartości dla error lub code w odpowiedziach API v1: