Fehlerbehebung

Übersicht

Die STACKIT Domain Services API verwendet standardisierte HTTP-Statuscodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen. Im Falle eines Fehlers gibt die API ein strukturiertes JSON-Objekt vom Typ application/problem+json zurück, das Ihnen hilft, die Ursache des Problems zu identifizieren.

Das Fehlerobjekt (Problem-Details)

Jede Fehlerantwort enthält einen maschinenlesbaren und menschenlesbaren Body, um das Debugging zu vereinfachen.

Feld	Beschreibung
type	Ein maschinenlesbarer Fehlercode (Slug), der den Fehlertyp identifiziert.
title	Eine kurze, menschenlesbare Zusammenfassung des Fehlers.
status	Der HTTP-Statuscode (z. B. 403).
detail	Eine spezifische Erklärung, was in diesem speziellen Fall fehlgeschlagen ist.
instance	Der URI-Pfad des Endpunkts, an dem der Fehler aufgetreten ist.

Fehlercode-Referenz

The following table lists the most common status codes you might encounter:

Status	Fehlertyp (Slug)	Beschreibung
400	bad-request	Ungültige Anfrage: Ein Pflichtfeld fehlt (z. B. name) oder das Format ist ungültig (z. B. falsches E-Mail-Format).
401	unauthorized	Nicht authentifiziert: Das Bearer-Token fehlt, ist abgelaufen oder ungültig.
403	forbidden	Zugriff verweigert: Ihr Token ist gültig, aber Sie besitzen keine Rechte für die angeforderte organizationId.
404	not-found	Nicht gefunden: Die angeforderte Ressource (z. B. domainId oder dnsZoneId) existiert nicht.
409	conflict	Konflikt: Die Ressource existiert bereits (z. B. doppelte Domain) oder wird derzeit verwendet und kann nicht gelöscht werden.
429	too-many-requests	Ratenlimit: Sie haben das Limit für API-Anfragen überschritten. Bitte warten Sie vor einem erneuten Versuch.
500	internal-server-error	Serverfehler: Auf unserer Seite ist ein unerwarteter Fehler aufgetreten. Bitte versuchen Sie es später erneut.
503	service-unavailable	Dienst nicht verfügbar: Ein Subsystem (z. B. ein externes Registry) ist vorübergehend nicht erreichbar.

Beispiel für eine Fehlerantwort

Wenn Sie versuchen, einen DNS-Eintrag in einer Zone zu erstellen, die nicht zu Ihrer Organisation gehört, antwortet die API wie folgt:

{
  "type": "forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have permission to access this resource.",
  "instance": "/api/v1/organizations/85ba9ac6.../dns-zones/primary"
}