fleet

POST `/v1/fleet/heartbeat`

Stamp fleet liveness, ship the host report, collect queued commands.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

Sent every heartbeatIntervalSeconds. Carries the host health report — the same document the console has always shown — because the heartbeat and the report answer the same question, and one call means the report can never be fresher than the heartbeat it is judged against. This is where a declared box becomes real capacity. A host that has never heartbeated is promoted to active and starts accepting deploys on its first successful beat; every beat after that leaves acceptsDeploys untouched, so an operator's drain sticks across an agent restart. A down host that heartbeats again is revived to active or draining according to the operator's existing intent. A decommissioned host gets continue: false and nothing is written. The response carries any commands the engine claimed for this host (bounded per tick). The claim is still SELECT … FOR UPDATE SKIP LOCKED, so exactly-once semantics are unchanged; only who runs the query moved, because a worker box has no database connection.

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`instance_id`	`string`	Да	—
`agent_version`	`string`	Не	—
`report`	`WorkerHostReport`	Не	One heartbeat's observed host state.

Отговор

Име	Тип	Задължително	Какво представлява
`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…
`continue_running`	`boolean`	Не	False only for an answered "this host is gone" (decommissioned or removed). An error is never reported as one — that distinction is what stops a transient failure retiring a…
`commands`	`WorkerClaimedCommand[]`	Не	—

Грешки, които този крайpoint може да върне

401 · 422 · 429

POST /v1/fleet/heartbeat