Fehlercodes
Jeder Fehler kommt als application/problem+json (RFC 9457) mit einem stabilen code und einem lesbaren detail:
{ "status": 409, "code": "node_offline", "detail": "The node is offline." }Programmiere gegen code; detail kann sich ändern.
Server und Dateien
Abschnitt betitelt „Server und Dateien“| Status | code |
Bedeutung |
|---|---|---|
| 400 | invalid_action |
die Ein-/Aus-Aktion ist nicht start, stop, restart oder kill |
| 400 | variable_invalid, variable_unknown |
der Wert einer Variablen verletzt ihre Regeln, oder das Template hat keine solche Variable |
| 400 | limit_invalid |
Arbeitsspeicher, CPU oder Speicherplatz unter dem Minimum |
| 400 | range_invalid |
Metrik-Zeitraum nicht 1h, 6h, 24h oder 7d |
| 400 | count_invalid |
mehr als 20 Server auf einmal oder weniger als 1 |
| 400 | custom_ports_not_allowed, custom_ports_invalid |
das Spiel hat feste Ports, oder die Rolle eines zusätzlichen Ports ist ungültig oder doppelt |
| 400 | forward_target_ipv4 |
Portweiterleitungen brauchen eine IPv4-Adresse |
| 400 | backup_invalid |
die hochgeladene Datei ist kein .tar.gz |
| 400 | upload_out_of_order |
das offset eines Upload-Teils setzt den Upload nicht fort |
| 400 | no_free_allocation |
der Node hat keinen freien Port für eine Rolle |
| 403 | forbidden |
die Aktion oder der Pfad ist für dich nicht erlaubt |
| 403 | path_outside |
der Pfad verlässt die Dateien des Servers |
| 403 | token_not_allowed |
API-Tokens können diesen Endpoint nicht verwenden |
| 404 | not_found, server_not_found |
unbekannte Datei oder unbekannter Server, oder gar kein Zugriff |
| 409 | node_offline |
der Agent des Nodes ist nicht verbunden |
| 409 | invalid_state |
im Zustand des Servers nicht möglich, z. B. ein Befehl, während er offline ist |
| 409 | disk_full |
das Schreiben würde das Speicherlimit des Servers überschreiten |
| 409 | exists, is_directory |
das Ziel existiert, oder ist ein Ordner |
| 409 | backup_busy, backup_locked |
das Backup ist in Gebrauch, oder gesperrt |
| 409 | schedule_running |
der Schedule läuft bereits |
| 412 | precondition_failed |
If-Match / If-None-Match traf nicht zu: Die Datei hat sich geändert |
Konten, Tenants und Nodes
Abschnitt betitelt „Konten, Tenants und Nodes“| Status | code |
|---|---|
| 400 | url_invalid, events_required, permissions_required, invalid_ip, invalid_ports, registry_invalid, template_invalid, invalid_code, email_unchanged, token_invalid |
| 403 | invalid_credentials, locked_out, tenant_creation_disabled, password_wrong, confirmation_wrong, setup_token_invalid, cross_origin |
| 404 | tenant_not_found, node_not_found, not_a_member, invitation_invalid |
| 409 | account_exists, already_member, last_owner, last_operator, last_sign_in_method, node_in_use, tenant_in_use, template_in_use, allocation_in_use, steam_account_in_use, ssh_key_exists, sole_owner, email_not_configured, master_key_required |
Fehlgeschlagene Authentisierung (Token fehlt, ist ungültig, widerrufen oder abgelaufen, oder wird aus dem falschen Netzwerk verwendet) antwortet mit 401.