fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`instance_id`	`string`	Evet	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`worker_id`	`string`	Hayır	—
`hostname`	`string`	Hayır	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Hayır	—
`accepts_deploys`	`boolean`	Hayır	—
`region`	`string`	Hayır	—
`pool`	`string`	Hayır	—
`driver`	`string`	Hayır	—
`capacity`	`integer`	Hayır	—
`product_lines`	`string[]`	Hayır	—
`heartbeat_interval_seconds`	`integer`	Hayır	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…

Bu uç noktanın dönderebileceği hatalar

401 · 422 · 429

POST /v1/fleet/drain