Umgang mit Fehlern

Übersicht overview

API-Fehler in der Adobe Experience Platform Edge Network Server-API können verschiedene Ursachen haben: interne (Edge Network selbst) oder externe (Eingabe, Konfiguration oder vorgelagerte Beziehung).

Fehlertypen error-types

Schweregrad

Server-API-Fehler können auch nach Schweregrad aufgeteilt werden:

Schwerwiegende Fehler fatal-errors

Schwerwiegende Fehler stoppen die Anforderungsverarbeitung und führen zur Rückgabe des Nicht-2xx-Antwortstatus. Sehen Sie sich den Abschnitt Fehlertypen an, um den erwarteten Statuscode für jeden Fehlertyp anzuzeigen.

Fehler werden von einem Antworttext begleitet, der ein Fehlerobjekt enthält. In diesem Fall enthält der Antworttext ein Problemdetail gemäß der Definition in RFC 7807-Problemdetails für HTTP-APIs.

Der zurückgegebene Inhaltstyp ist der Medientyp application/problem+json . Sofern vorhanden, enthält diese Antwort maschinenlesbare Details zum Fehler. Zu den Problemdetails zählen URI-Typen.

Alle Fehlerobjekte verfügen über die Nachrichteneigenschaften type, status, title, detail und report, sodass der API-Client erkennen kann, welches Problem vorliegt.

{
   "type":"https://ns.adobe.com/aep/errors/EXEG-0104-422",
   "status":422,
   "title":"Unprocessable entity",
   "detail":"Invalid request (report attached). Please check your input and try again.",
   "report":{
      "errors":[
         "Allowed Adobe version is 1.0 for standard 'Adobe' at index 0",
         "Allowed IAB version is 2.0 for standard 'IAB TCF' at index 1",
         "IAB consent string value must not be empty for standard 'IAB TCF' at index 1"
      ],
      "requestId":"0f8821e5-ed1a-4301-b445-5f336fb50ee8",
      "orgId":"53A16ACB5CC1D3760A495C99@AdobeOrg"
   }
}

Nicht tödliche Fehler non-fatal-errors

Nicht-tödliche Fehler können weiter aufgeschlüsselt werden in:

Bei nicht tödlichen Fehlern (ohne Warnungen) ändert der Server API den Antwortstatus auf 207 Multi-Status.

Warnungen hingegen sind meist informativ, da sie im Allgemeinen eine potenziell vorübergehende Bedingung darstellen, die sich nicht vollständig auf die Anfrage auswirkte. Ein Beispiel hierfür ist ein Teilprofil, das in der Segmentierungsmaschine gelesen wird. In diesem Fall hat die Genauigkeit bis zu einem gewissen Grad Auswirkungen, die Funktionalität wird jedoch weiterhin bereitgestellt.

Fehler, die nicht tödlich sind, werden im Format Problemdetails dargestellt, sind jedoch direkt in die Standardantwort des Edge-Gateways eingebettet, die vom Typ application/json ist.

{
  "requestId": "72eaa048-207e-4dde-bf16-0cb2b21336d5",
  "handle": [
  ],
  "errors": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0201-503",
      "status": 503,
      "title": "The 'com.adobe.experience.platform.ode' service is temporarily unable to serve this request. Please try again later."
    }
  ],
  "warnings": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0204-200",
      "status": 200,
      "title": "A warning occurred while calling the 'com.adobe.audiencemanager' service for this request.",
      "report": {
        "cause": {
          "message": "Cannot read related customer for device id: ...",
          "code": 202
        }
      }
    }
  ]
}

Umgang mit 4xx und 5xx Antworten