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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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