fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X POST https://api.zinndigital.com/v1/fleet/drain \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "instance_id": <string> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`instance_id`	`string`	Tak	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`worker_id`	`string`	Nie	—
`hostname`	`string`	Nie	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Nie	—
`accepts_deploys`	`boolean`	Nie	—
`region`	`string`	Nie	—
`pool`	`string`	Nie	—
`driver`	`string`	Nie	—
`capacity`	`integer`	Nie	—
`product_lines`	`string[]`	Nie	—
`heartbeat_interval_seconds`	`integer`	Nie	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…

Błędy, które ten punkt końcowy może zwrócić

401 · 422 · 429

POST /v1/fleet/drain