Fehler
Wie die API Fehler meldet und was jeder Code bedeutet.
Die API gibt Fehler im standardmäßigen GraphQL-Array errors zurück; der HTTP-Status bleibt 200, und data kann null oder unvollständig sein. Jeder Fehler nennt seine Art in extensions.code, und eine abgelehnte Anfrage nennt den Grund in extensions.reasonCode.
{
"errors": [
{
"message": "Input does not meet data validation rules.",
"path": ["issueCreate"],
"extensions": {
"code": "VALIDATION",
"reasonCode": "REQUIRED",
"field": "issueCreate.title",
"reason": "title is required"
}
}
],
"data": null
}Fehler bei beliebigen Anfragen
Diese Fehler kann jede Operation der gesamten API zurückgeben.
UNAUTHENTICATEDIhr API-Schlüssel fehlt, ist ungültig oder abgelaufen.RATE_LIMITSie haben zu viele Anfragen gesendet. Warten Sie, bevor Sie es erneut versuchen.INTERNALEin unerwarteter Serverfehler ist aufgetreten. Versuchen Sie es später noch einmal.Spezifische Fehler
Je nach Operation und den Daten, die Sie senden, kann eine Anfrage außerdem zurückgeben:
NOT_FOUNDDie Ressource existiert nicht oder Ihre Organisation hat keinen Zugriff darauf.VALIDATIONDie Anfrage wurde wegen ihres Inhalts abgelehnt. extensions.reasonCode nennt den Grund – siehe „Ablehnungen“ weiter unten.INPUTEine ID oder ein Token, das nicht gelesen werden kann: ein Fehler im Client oder ein defekter Link, nie eine Eingabe einer Person. Behandeln Sie es wie NOT_FOUND.CONSTRAINTZwei Anfragen haben gleichzeitig denselben Schreibvorgang versucht, und diese hat verloren. Ein erneuter Versuch funktioniert in der Regel.Ablehnungen
Eine abgelehnte Anfrage ist immer VALIDATION, mit diesen Erweiterungen. Entscheiden Sie anhand von reasonCode, nie anhand von message, das bei jeder Ablehnung derselbe Satz ist.
reasonCodeWarum die Anfrage abgelehnt wurde, als feststehendes Wort. Verwenden Sie es als Übersetzungsschlüssel.fieldWo in der Anfrage das Problem liegt: der Name der Operation, dann der Pfad im Gesendeten, ohne die Hülle input und mit Listenpositionen ab null (domainUpdate.nameServers[1]). Fehlt, wenn die Ablehnung die ganze Anfrage betrifft.paramsWerte, die die Erklärung braucht, etwa kind oder ein Hostname. Fehlt, wenn es keine gibt.reasonDieselbe Erklärung auf Englisch, für Entwickler. Nicht dafür gedacht, Benutzern angezeigt zu werden.Gründe, die jede Operation nennen kann
Neben den Gründen, die bei jeder Operation aufgeführt sind, kann jede auch mit diesen antworten. Bei den letzten vier nennt params.kind, um welche Art von Element es geht (PROJECT, DNS_ZONE, DNS_RECORD …).
MALFORMEDEin Wert hat nicht die erwartete Form. reason nennt das Problem.REQUIREDEin Wert fehlt, oder für ein Feld, das nicht geleert werden kann, wurde null gesendet.TOO_LARGEEin Text oder eine Datei ist größer als erlaubt. params.maxBytes ist die Grenze.NOT_FOUNDEtwas, worauf die Anfrage verweist, existiert nicht oder gehört einer anderen Organisation.TAKENDer Name wird bereits von etwas anderem verwendet.IN_USEEs kann nicht entfernt werden, solange es noch verwendet wird.DELETEDEs wurde gelöscht, und bis zur Wiederherstellung kann nichts daran geändert werden.