Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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 depl… |
Ошибки, которые может возвращать этот эндпоинт
401 · 422 · 429