fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`instance_id`	`string`	Da	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`worker_id`	`string`	Ne	—
`hostname`	`string`	Ne	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Ne	—
`accepts_deploys`	`boolean`	Ne	—
`region`	`string`	Ne	—
`pool`	`string`	Ne	—
`driver`	`string`	Ne	—
`capacity`	`integer`	Ne	—
`product_lines`	`string[]`	Ne	—
`heartbeat_interval_seconds`	`integer`	Ne	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…

Pogreške koje ova krajnja točka može vratiti

401 · 422 · 429

POST /v1/fleet/drain