Для AI-агентов: markdown этой страницы — /docs-content/infra/lifecycle/repair.md индекс документации — /llms.txt

Восстановить туннель

POST /v1/infra/servers/:id/repair

Запускает фоновое восстановление туннеля Black Hole через serial console облачного провайдера. Используйте, когда виртуальная машина в running, но blackholeStatus застрял в DISCONNECTED или NONE — то есть агент туннеля не подключается. Процедура проходит через serial console (минуя файрвол) и включает: впрыск SSH-ключа → подключение к машине → полную переустановку агента с актуальной версией → ожидание переподключения. Длится до 2 минут (до 4 минут, если понадобился резервный путь установки — см. «Известные особенности»). Сам вызов возвращается сразу и не ждёт завершения, прогресс смотрите через GET /repair-status.

Перед восстановлением занятого канала прочитайте операцию. /repair переустанавливает агента туннеля и может прервать живые синхронные команды /exec и их побочные эффекты, включая транзакции во внешней базе. Длительные задачи отдельной машины выполняются независимо: восстановление или разрыв туннеля не гарантируют их остановку. При EXEC_BUSY сначала прочитайте операции сервера с kind=exec и их исходы. Гардированный /unstick используйте только при подтверждённой утечке синхронного мьютекса после независимого подтверждения простоя. DELETE /lock остаётся последним шагом восстановления лока после этой проверки. /repair нужен, когда туннель действительно не подключается; он не служит отменой или разрешением повторить команду. На STANDALONE работающая длительная задача занимает канал после освобождения платформенного лока с 202. Опрашивайте её операцию; при неизвестном исходе нужны поддержка и независимое подтверждение полной остановки. Отсутствие autoExpiresInSeconds не доказывает утечку мьютекса. Восстановление туннеля и удаление лока не снимают ограничение приёма длительной задачи. В Galaxy команды выполняются синхронно с пределом 600 секунд и общим каналом для всех приложений и выкладок; задача соседнего приложения может не попасть в ваш список операций, поэтому пустой список не доказывает простой хоста.

Параметры

Параметр В Тип Обяз. Описание
id path string (UUID) да ID сервера

Тело запроса пустое.

Примеры

curl — личный ключ

Terminal
curl -X POST -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/repair

curl — OAuth-приложение

Terminal
curl -X POST -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/repair

JavaScript — личный ключ

javascript
// Запустить ремонт и периодически опрашивать статус
await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/repair`,
  { method: 'POST', headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)

while (true) {
  await new Promise(r => setTimeout(r, 10000))
  const res = await fetch(
    `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/repair-status`,
    { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
  )
  const { data } = await res.json()
  console.log(`Шаг: ${data.step ?? data.status}`)
  if (data.status === 'idle' || data.status === 'completed' || data.status === 'failed') break
}

JavaScript — OAuth-приложение

javascript
await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/repair`,
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

Поля ответа

Поле Тип Описание
success boolean true — ремонт успешно запущен в фоне
data.status string Всегда "started" при успехе

Пример ответа

JSON
{
  "success": true,
  "data": { "status": "started" }
}

Пример ответа при ошибке

409 — ремонт заблокирован (например, сервер помечен preventWake=true):

JSON
{
  "success": false,
  "error": {
    "code": "REPAIR_BLOCKED",
    "message": "Repair blocked: server prevents wake"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_INPUT У записи нет облачной виртуальной машины: создание не завершилось, машина удалена у провайдера — тогда сервер нужно заменить: удалить его может ключ, которому сервер принадлежит, а создать новый — ключ со скоупом vibe:infra в режиме READWRITE. Тот же код отвечает galaxy-приложению: у контейнера своей машины нет, ремонт к нему не применяется — Galaxy-приложение
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Ключ не опознан: такой строки на платформе нет
403 INFRA_FORBIDDEN_FOR_COWORK_KEY Вызов сделан ключом Cowork/Code — такой ключ работает только с данными, изменяющие операции ему закрыты. Что делать — Проектный ключ для деплоя
403 SERVER_ROLE_FORBIDDEN Вы состоите в команде разработки этого сервера с ролью «Разработчик», а операция открыта роли «Администратор». В error.hint придут ваша роль, требуемый порог и перечень открытых вам вызовов. Разбор ролей — Список серверов
404 NOT_FOUND Сервер не существует, удалён или привязан к другому API-ключу, и вы не состоите в его команде разработки
409 REPAIR_BLOCKED Ремонт заблокирован: сервер спит или в ошибке, и на нём стоит запрет на пробуждение preventWake=true (например, заморозка баланса, окончание доступа к платформе, административная блокировка)
422 GUEST_NOT_BOOTING Гостевая операционная система машины не загружается. Ремонт этого не лечит, поэтому вызов отклоняется до обращения к машине и не будит её — сервер нужно пересоздать
422 REPAIR_NO_TRANSPORT У платформы нет канала на сервер: по SSH не достучаться, консольного доступа нет, а ключа для входа у записи нет. Вызов отклоняется до обращения к машине и не будит её — сервер нужно пересоздать или восстановить из бэкапа, если он есть
429 RATE_LIMITED Превышен общий лимит запросов платформы

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Почему serial console, а не SSH. Когда агент не подключён, SSH через iptables BLACKHOLE-сервера недоступен. Serial console провайдера Bitrix Cloud минует файрвол на уровне гипервизора и позволяет внедрить SSH-ключ в уже работающую виртуальную машину, не перезагружая её.
  • Два пути установки агента. По умолчанию агент доустанавливается по входящему SSH — это быстро. Если входящий SSH недоступен (порт 22 не отвечает, IP в базе устарел, правила облачного файрвола, sshd не поднят), процедура устанавливает агента out-of-band через ту же serial console: агенту нужен только ИСХОДЯЩИЙ коннект к gateway, поэтому входящий доступ для переустановки не требуется. У машины без публичного IP используется сразу serial console, а там, где её нет, ремонт завершается кодом REPAIR_NO_TRANSPORT. Резервная попытка добавляет до двух минут к уже неуспешному вызову. Если не сработали оба пути, error в GET /repair-status содержит обе причины через ; serial fallback:.
  • Идемпотентно. Процедура выполняет полный цикл (стоп агента → скачивание свежего бинарника → чистая конфигурация → запуск) и безопасна для здорового сервера — навредить не может. Повторный вызов во время идущего ремонта просто вернёт 409/то же started, ничего не ломает.
  • Режим сервера сохраняется. OPEN-сервер остаётся OPEN (iptables не трогается), BLACKHOLE — BLACKHOLE.
  • Как разблокировать REPAIR_BLOCKED. Если сервер помечен preventWake (например, заморозка баланса, окончание доступа к платформе, административная блокировка) — сначала устраните причину (пополните баланс или восстановите доступ к платформе), потом повторите /repair.
  • GUEST_NOT_BOOTING ремонтом не лечится. Признак виден заранее в поле provisionErrorCode карточки сервера — GET /v1/infra/servers/:id. Прочитайте его перед вызовом: у такой машины ремонт отклоняется, а единственное доступное действие — удалить сервер и создать новый.
  • Нехватка места на диске останавливает ремонт. GET /repair-status вернёт status: "failed", а текст error начнётся с DISK_FULL:. Тот же код появится в поле provisionErrorCode карточки сервера — GET /v1/infra/servers/:id. Повтор ремонта поможет только после того, как на диске освободится место. Успешный ремонт снимает код.
  • REPAIR_NO_TRANSPORT — у платформы нет канала на сервер. Если отказ известен заранее (у записи нет ключа для входа), POST /repair отвечает 422: такой сервер нужно пересоздать или восстановить из бэкапа, если он есть. Если платформа не смогла попасть на сервер уже в ходе ремонта, GET /repair-status вернёт status: "failed", а текст error начнётся с REPAIR_NO_TRANSPORT: и продолжится фразой: The platform could not reach this server to reinstall the agent: it has no working SSH path and no console access. Retry the repair later; if it keeps failing, contact support. Повторите ремонт позже, а если отказ сохраняется, обратитесь в поддержку. После такого отказа ремонт не усыпляет обратно сервер, который сам разбудил: сервер остаётся включённым, пока не уснёт по своей настройке простоя или пока вы не усыпите его сами. У остальных сбоев ремонта свой текст ошибки. Пока сервер ещё запускается, платформа повторяет вход; ошибка аутентификации отклоняет ремонт сразу.

Смотрите также