Skip to main content
Jede fehlgeschlagene Anfrage an die Square Cloud API antwortet mit einem HTTP-Status und einem JSON-Body, der einen maschinenlesbaren code enthält. Diese Seite listet jeden Code nach Bereich geordnet. Jede Endpoint-Seite nennt außerdem die Codes, die dieser Endpoint am häufigsten liefert.
Blob Storage hat eine eigene Liste von Codes, und das AI Gateway antwortet im Fehlerformat von OpenAI mit kleingeschriebenen Codes. Beide werden hier nicht behandelt.

Fehlerformat

Die Liste der Codes wächst mit der Zeit. Behandle einen unbekannten Code als allgemeinen Fehler des HTTP-Status, mit dem er kam: Korrigiere die Anfrage bei 4xx, warte bei 429 und versuche es bei 5xx später erneut.

Wiederholungsversuche

Die API sendet keinen Header Retry-After, die Entscheidung liegt also bei dir. Eine sichere Strategie: 202 SNAPSHOT_PROCESSING behält aus Kompatibilitätsgründen die Fehlerhülle, ist aber kein Fehler: Der Snapshot wird noch erstellt und erscheint von selbst in der Liste. Fordere ihn nicht erneut an.

Rate Limits

Zwei Codes antworten mit 429, und sie bedeuten Verschiedenes:
  • RATE_LIMITED: das Anfragebudget deines Kontos oder API-Schlüssels, gezählt pro 60 Sekunden und von deinem Plan festgelegt (siehe die Werte pro Plan). Darüber hinaus lehnt die API deine Anfragen bis zu 30 Minuten lang ab. Einige Endpoints antworten auch bei ihren eigenen Limits mit RATE_LIMITED, und eine IP-Adresse, die hartnäckig API-Schlüssel sendet, die zu keinem Konto gehören, wird für kurze Zeit gesperrt.
  • KEEP_CALM: das eigene Limit eines Endpoints, etwa ein Neustart alle paar Sekunden. Warte einen Moment und versuche es erneut. Das Limit jedes Endpoints steht auf seiner Seite.

Authentifizierung und Berechtigungen

Validierung der Anfrage

Kontingente und Verbindungslimits

Anwendungen

Upload und Commit

Prüfungen von Zip und Konfiguration

Wenn du eine Anwendung hochlädst, prüft der Server, der sie ausführen wird, das Zip und seine Konfigurationsdatei (squarecloud.app oder squarecloud.config). Eine fehlgeschlagene Prüfung antwortet mit 400 und einem dieser Codes, und nichts wird deployt. Korrigiere das Zip und lade es erneut hoch. Ein Commit liest die Konfigurationsdatei nicht: Er kann aus dieser Liste nur mit FAILED_EXTRACT oder CONTAINER_INSUFFICIENT_DISK_SPACE scheitern.

Umgebungsvariablen

Dateien

Deploys und GitHub

Ein fehlgeschlagener Git-Deploy ist kein HTTP-Fehler: Er erscheint im Deploy-Verlauf als Ereignis mit state: "error" und einem code wie DEPLOY_FAILED.

Netzwerk und Domains

Snapshots

Datenbanken

Workspaces

Plattform

Die Codes AI_* (AI_DAILY_LIMIT_REACHED, AI_NO_PLAN_LIMIT_REACHED, AI_MAX_CONCURRENT_STREAMS, AI_UNAVAILABLE) gehören zum KI-Assistenten des Dashboards, der eine Dashboard-Sitzung braucht. Ein API-Schlüssel erhält sie nie.

Siehe auch