fleet
POST /v1/fleet/drain
Take this host out of placement on graceful shutdown.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
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 конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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 depl… |
Грешки, които този крайpoint може да върне
401 · 422 · 429