fleet
POST /v1/fleet/drain
Take this host out of placement on graceful shutdown.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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 depl… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 422 · 429