fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`instance_id`	`string`	Ano	—

Odpověď

Název	Typ	Požadováno	Co to je
`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 depl…

Chyby, které může tento koncový bod vrátit

401 · 422 · 429

POST /v1/fleet/drain