fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

प्रमाणन

एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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 कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव 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…

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 422 · 429

POST /v1/fleet/drain