fleet
POST /v1/fleet/drain
Take this host out of placement on graceful shutdown.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/fleet/drain \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "instance_id": <string> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
instance_id | string | Да | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
worker_id | string | Не | — |
hostname | string | Не | — |
status | string<provisioning, active, draining, down, decommissioned> | Не | — |
accepts_deploys | boolean | Не | — |
region | string | Не | — |
pool | string | Не | — |
driver | string | Не | — |
capacity | integer | Не | — |
product_lines | string[] | Не | — |
heartbeat_interval_seconds | integer | Не | 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… |
Грешке које ова крајња тачка може вратити
401 · 422 · 429