Fehler

Wenn eine Anfrage fehlschlägt, gibt die API einen HTTP-Fehlerstatus und einen JSON-Body zurück, der den Fehler beschreibt. Diese Referenz führt das Format, die Codes und ihre Behandlung auf.

FehlerformatLink kopieren

{
  "code": "VALIDATION_FAILED",
  "message": "2 fields failed validation: name, sizeGb",
  "field": "name",
  "details": {
    "errors": [
      { "field": "name", "code": "string_too_short", "message": "String should have at least 1 character" },
      { "field": "sizeGb", "code": "missing", "message": "Field required" }
    ]
  }
}

Die API verwendet 400 Bad Request nicht: Eine Anfrage, die nicht dem Schema des Vorgangs entspricht, gibt 422 Unprocessable Entity zurück.

Statuscodes und FehlercodesLink kopieren

Einige Anfragen geben auch 404 Not Found für eine Funktion zurück, die die Region nicht anbietet, z. B. wenn Sie Verschlüsselung im Ruhezustand anfordern, wo die Region sie nicht bereitstellen kann. Die Meldung nennt die Funktion und die Region. Eine Wiederholung kann diese Antwort nicht ändern.

Importierte ProjekteLink kopieren

Diese Codes treten nur bei Projekten auf, die der Plattformbetreiber mit ihren vorhandenen Ressourcen für Sie importiert hat:

ValidierungsfehlerLink kopieren

Eine Antwort 422 Unprocessable Entity für eine ungültige Anfrage listet alle Probleme auf einmal in details.errors auf. Jeder Eintrag hat:

• field: den Pfad des Felds in der Anfrage, mit Punkten zwischen den Ebenen, oder null, wenn das Problem den Body als Ganzes betrifft.
• code: die Art des Problems, z. B. missing oder string_too_short.
• message: eine Beschreibung auf Englisch.

Das field der obersten Ebene beschreibt den ersten Eintrag, und message nennt jedes Feld. Korrigieren Sie alle aufgeführten Felder, bevor Sie die Anfrage erneut senden.

RatenbegrenzungLink kopieren

Das API-Gateway begrenzt, wie schnell Anfragen mit einzelnen Anmeldedaten gesendet werden können. Jedes API-Token, jeder Dienstkontoschlüssel und jede Konsolensitzung hat ein eigenes Limit, und Anfragen ohne Anmeldedaten werden nach Quell-IP-Adresse begrenzt. Das Limit erlaubt kurze Spitzen über der dauerhaften Rate.

Für ein API-Token oder einen Dienstkontoschlüssel gilt das Limit pro Anmeldedaten und zusätzlich pro Mandant, über alle Anmeldedaten des Mandanten zusammen. Jede Antwort auf eine solche Anfrage enthält diese Header:

Wenn Sie das Limit überschreiten, antwortet das Gateway mit 429 Too Many Requests, dem Code RATE_LIMITED, "retryable": true und einem Header Retry-After mit der Anzahl der zu wartenden Sekunden, mindestens 1. Warten Sie mindestens so lange, bevor Sie die nächste Anfrage senden.

Dieses Limit gilt für Anfragen an die REST-API. Die Limits von Anwendungs-Credentials finden Sie unter Limits der OpenStack-API.

Fehler in asynchronen VorgängenLink kopieren

Wenn die Arbeit einer Anfrage mit 202 Accepted fehlschlägt, wird der state des Vorgangs zu FAILED, und sein Feld error enthält einen Fehler im obigen Format. Ein erfolgreicher Vorgang kann eine warning im selben Format enthalten, wenn etwas, das Sie angefordert haben, nicht geliefert werden konnte. Siehe Synchrone und asynchrone Anfragen.

Antworten aus dem Netzwerk vor der APILink kopieren

Während die Plattform aktualisiert wird, kann ein Proxy vor der API mit 500, 502, 503 oder 504 und einem Body antworten, der nicht dem obigen Fehlerformat entspricht, z. B. mit reinem Text. Eine solche Antwort bedeutet, dass Ihre Anfrage die API nicht erreicht hat. Wiederholen Sie sie mit Backoff und demselben Idempotency-Key.

Anfragen nach Fehlern wiederholenLink kopieren

• Wiederholen Sie die Anfrage, wenn die Antwort "retryable": true enthält, und nach einer Antwort 500, 502, 503 oder 504, die nicht im Fehlerformat vorliegt. Senden Sie denselben Idempotency-Key erneut. Siehe Idempotente Anfragen.
• Warten Sie vor jeder Wiederholung länger, z. B. 1, 2, 4 und dann 8 Sekunden. Warten Sie nach einer Antwort 429 mindestens die Zeit aus Retry-After.
• Wiederholen Sie andere 4xx-Fehler nicht unverändert. Korrigieren Sie zuerst die Anfrage, die Anmeldedaten oder den Status der Ressource.

Zugehöriger InhaltLink kopieren

• REST-API-Übersicht
• Mit API-Tokens authentifizieren
• Idempotente Anfragen