fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

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.

请求正文

名称	类型	必填	内容简介
`instance_id`	`string`	是	—

响应

名称	类型	必填	内容简介
`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 depl…

此端点可能返回的错误

401 · 422 · 429

POST /v1/fleet/drain