Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/fleet/drain \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "instance_id": <string> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
The only availability change a box may make for itself, and safe in the direction it moves: a host can take itself **out** of service and never back **in**. Returning requires either the once-only first-heartbeat promotion or a staff undrain (`setWorkerDrain`). Idempotent; a `decommissioned` host is left alone.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
instance_id | string | Igen | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
worker_id | string | Nem | — |
hostname | string | Nem | — |
status | string<provisioning, active, draining, down, decommissioned> | Nem | — |
accepts_deploys | boolean | Nem | — |
region | string | Nem | — |
pool | string | Nem | — |
driver | string | Nem | — |
capacity | integer | Nem | — |
product_lines | string[] | Nem | — |
heartbeat_interval_seconds | integer | Nem | How often to heartbeat, decided engine-side. The box no longer reads its own interval from an env file, so "the host-down window is ten missed beats" stays a fact about the depl… |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 422 · 429