Остановить инстанс

Инициирует остановку сервера.

POST https://api.yougpu.ru/instances/{id}/stop

Заголовки (Headers)

Заголовок	Значение	Описание
X-API-KEY	<YOUR_API_KEY>	Ваш API ключ
Content-Type	application/json	Формат данных

Параметры пути (Path)

Параметр

Тип

Описание

id*

string

Уникальный UUID инстанса.

Примеры кода

curl -X POST "https://api.yougpu.ru/instances/e3b0c442-989b-464c-8693-e1d5a7d65b32/stop" \
  -H "X-API-KEY: <YOUR_API_KEY>"

import requests

url = "https://api.yougpu.ru/instances/e3b0c442-989b-464c-8693-e1d5a7d65b32/stop"
headers = {
    "X-API-KEY": "<YOUR_API_KEY>"
}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch('https://api.yougpu.ru/instances/e3b0c442-989b-464c-8693-e1d5a7d65b32/stop', {
  "method": "POST",
  "headers": {
      "X-API-KEY": "<YOUR_API_KEY>"
  }
});
const data = await response.json();
console.log(data);

Ответ

200 OK

{
  "status": "success",
  "code": 200,
  "data": {
    "status": "STOPPING",
  }
}

400 Bad Request

Возникает, если инстанс не находится в статусе ACTIVE (например, уже остановлен или находится в процессе создания).

{
  "statusCode": 400,
  "message": "Instance is not in ACTIVE state or already stopping",
  "error": "Bad Request"
}

500 Internal Server Error

Возникает, если провайдер не смог выполнить команду остановки. Статус инстанса автоматически возвращается в ACTIVE.

{
  "statusCode": 500,
  "message": "Failed to stop instance on provider side.",
  "error": "Internal Server Error"
}

Структура ответа

Параметр

Тип

Описание

status

string

Статус выполнения запроса.

code

number

HTTP код ответа.

data

object

Данные ответа:

status

InstanceStatus

Текущий статус:

CREATING

Value

0. Запись создана в БД, процесс инициализации.

PROVISIONING

Value

1. Запрос отправлен провайдеру, ожидаем выделения железа.

INSTALLING

Value

2. Идёт установка выбранного шаблона(Jupyter, ComfyUI). Сервер работает, SSH доступен.

ACTIVE

Value

3. Сервер работает, SSH доступен.

STOPPING

Value

4. Процесс остановки (Graceful shutdown).

STOPPED

Value

5. Выключен. Диск занят, данные сохранены.

STARTING

Value

6. Запуск ранее остановленного сервера.

REBOOTING

Value

7. Перезагрузка по команде пользователя.

TERMINATING

Value

8. Процесс безвозвратного удаления.

TERMINATED

Value

9. Сервер удален (Soft Delete).

ERROR

Value

Ошибка на стороне провайдера.

Есть вопросы?

Поддержка Чат

Нашли ошибку? Сообщить