Перейти к содержимому
YouGPU Docs
TG

Создать инстанс

Инициирует процесс создания новой виртуальной машины. Метод проверяет наличие средств, резервирует баланс и ставит задачу на развертывание в очередь.

POST https://api.yougpu.ru/instances

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

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

Параметры тела (Body)

Заголовок раздела «Параметры тела (Body)»
Параметр
Тип
Описание
offer_id*
string
ID выбранного предложения (оффера) из каталога.
image_id*
string
ID базового образа ОС.
instance_name*
string
Уникальное имя инстанса. От 3 до 50 символов. Только латиница, цифры и дефис. Должно начинаться с буквы и не заканчиваться дефисом.
ssh_keys
string[]
Массив ID SSH-ключей, которые будут добавлены на сервер.
template_id
string
ID шаблона приложения (если используется).
storage_drive_id
string
ID облачного диска (если используется).
docker_config
object
Конфигурация для запуска Docker-контейнера:
image*
string
Название Docker-образа (например, 'pytorch/pytorch:latest').
run_command
string
Команда запуска (Entrypoint/Command).
shm_size_gb
number
Размер разделяемой памяти (/dev/shm) в ГБ. Минимум 0.1.
ports
array
Проброс портов:
internal_port
number
Порт внутри контейнера (1-65535).
external_port
number
Внешний порт инстанса (1-65535).
protocol
string
TCP или UDP. По умолчанию TCP.
name
string
Метка порта.
is_main
boolean
Флаг основного порта для подключения (например, для Jupyter).
env
array
Переменные окружения:
key
string
Имя переменной (валидный формат Env Key).
value
string
Значение переменной.
volumes
array
Монтирование директорий:
container_path
string
Путь внутри контейнера.
host_path
string
Путь на хостовой машине.

Примеры кода

Заголовок раздела «Примеры кода»
Окно терминала
curl -X POST "https://api.yougpu.ru/instances" \
  -H "X-API-KEY: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_name": "ml-worker-01",
    "offer_id": "8b3d4f5e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "image_id": "ubuntu-24.04-cuda-12.8",
    "ssh_keys": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "storage_drive_id": "717fdac6-51db-4272-a6e3-d1a4f89cdc5f",
    "docker_config": {
      "image": "nvidia/cuda:12.1.0-base-ubuntu22.04",
      "env": [
        {
          "key": "NVIDIA_VISIBLE_DEVICES",
          "value": "all"
        }
      ],
      "ports": [
        {
          "internal_port": 8888,
          "external_port": 8888,
          "name": "jupyter",
          "is_main": true
        }
      ]
    }
  }'
Окно терминала
curl -X POST "https://api.yougpu.ru/instances" \
  -H "X-API-KEY: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_name": "ml-worker-01",
    "offer_id": "8b3d4f5e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "image_id": "ubuntu-22.04-cuda-12.4",
    "template_id": "8b3d4f5e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "ssh_keys": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }'

Ответ

Заголовок раздела «Ответ»
201 Created 
{
  "status": "success",
  "code": 201,
  "data": {
    "id": "e3b0c442-989b-464c-8693-e1d5a7d65b32",
    "name": "ml-worker-01",
    "status": "PROVISIONING",
    "price_per_hour_snapshot": "18.500000",
    "ip_address": "203.0.113.42",
    "ssh_username": "root",
    "ssh_port": 22,
    "external_id": "srv-847291",
    "docker_config": null,
    "failure_reason": null,
    "metadata": {
      "environment_name": "default-NORWAY-1"
    },
    "connection_info": {
      "type": "os_only",
      "secrets": {},
      "endpoints": []
    },
    "application_template": null,
    "storage_drive": null,
    "offer": {
      "id": "8b3d4f5e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
      "name": "RTX-A4000",
      "interconnect": "PCIE",
      "external_offer_id": "n3-RTX-A4000x1",
      "in_stock": true,
      "region": "NORWAY-1",
      "gpu_count": 1,
      "cpu_cores": 4,
      "vram_gb": 21,
      "ram_gb": 21,
      "root_disk_gb": 100,
      "ephemeral_disk_gb": 0,
      "metadata": {
        "environment_name": "default-NORWAY-1"
      },
      "gpu_model": {
        "id": "a7267bfc-690e-4deb-8c5c-a9748f186494",
        "name": "RTX A4000",
        "slug": "rtx-a4000",
        "description": null,
        "vram_gb": 21,
        "created_at": "2026-02-02T20:57:27.363Z",
        "updated_at": "2026-02-15T18:03:38.370Z"
      },
      "created_at": "2026-02-03T19:31:37.771Z",
      "updated_at": "2026-02-28T10:21:43.851Z"
    },
    "provider": {
      "id": "0602b1ef-537c-46e5-b902-543d01c52def",
      "name": "Hyperstack",
      "slug": "hyperstack",
      "created_at": "2026-02-02T20:57:27.929Z",
      "updated_at": "2026-02-15T18:03:39.419Z"
    },
    "base_image": {
      "id": "ubuntu-24.04-cuda-12.8",
      "name": "Ubuntu 24.04 LTS (CUDA 12.8)",
      "description": "Актуальный стандарт 2026 года. Driver 570+, максимальная производительность H100.",
      "logo_url": "https://assets.ubuntu.com/v1/29985a98-ubuntu-logo-icon.svg",
      "os_type": "linux",
      "distro_version": "24.04",
      "driver_version": "570.86.10",
      "cuda_version": "12.8",
      "supports_docker": true,
      "supports_rdp": false,
      "specs": {
        "docker": "26.0",
        "kernel": "6.8.0",
        "python": "3.12"
      },
      "sort_order": 90
    },
    "ssh_keys": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "master",
        "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGxampleFakePublicKeyDataThatIsSafeToShare user@example.com",
        "fingerprint": null,
        "is_default": false,
        "created_at": "2026-02-17T00:44:15.031Z",
        "updated_at": "2026-02-24T18:15:56.147Z"
      }
    ],
    "paid_until": null,
    "last_billed_at": "2026-02-26T20:17:00.400Z",
    "started_at": "2026-02-26T20:17:00.400Z",
    "terminated_at": "2026-02-26T20:19:09.683Z",
    "created_at": "2026-02-26T20:16:11.321Z",
    "updated_at": "2026-02-26T20:19:09.684Z"
  }
}

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

Заголовок раздела «Структура ответа»
Параметр
Тип
Описание
status
string
Статус выполнения запроса (например, success).
code
number
HTTP код ответа.
data
object
Данные ответа:
id
string
Уникальный ID инстанса.
name
string
Имя сервера.
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
Ошибка на стороне провайдера.
price_per_hour_snapshot
string
Стоимость часа аренды (зафиксированная).
ip_address
string | null
Публичный IP.
ssh_username
string
Имя пользователя для SSH подключения (обычно root или ubuntu).
ssh_port
number
Порт для SSH подключения (обычно 22).
external_id
string | null
ID сервера на стороне провайдера.
docker_config
json | null
Пользовательская конфигурация Docker (если есть).
failure_reason
string | null
Причина ошибки, если статус инстанса ERROR.
metadata
json | null
Дополнительные метаданные инстанса (токены, окружение и т.д.).
connection_info
object | null
Данные для подключения к приложениям внутри инстанса:
type
string
Тип подключения (os_only, template, custom_docker).
secrets
object
Сгенерированные пароли и токены (например, для JupyterLab).
endpoints
array
Список проброшенных портов и ссылок.
application_template
object | null
Данные использованного шаблона приложения (если сервер создан из шаблона).
storage_drive
object | null
Данные прикрепленного облачного хранилища.
offer
object
Полная информация предложения:
id
string
ID конфигурации.
name
string
Название тарифа.
interconnect
string
Тип соединения GPU (PCIE, SXM5 и т.д.).
provider_id
string
ID провайдера.
gpu_model_id
string
ID модели GPU.
external_offer_id
string
ID тарифа у провайдера.
in_stock
boolean
Доступность конфигурации.
region
string
Код региона размещения.
gpu_count
number
Количество GPU карт.
cpu_cores
number
Количество ядер CPU.
vram_gb
number
Общий объем видеопамяти (ГБ).
ram_gb
number
Объем оперативной памяти (ГБ).
root_disk_gb
number
Размер системного диска.
ephemeral_disk_gb
number
Размер быстрого локального хранилища.
metadata
json | null
Дополнительные параметры провайдера.
created_at
string
Дата создания.
updated_at
string
Дата обновления.
gpu_model
object
Модель видеокарты:
id
string
ID модели.
name
string
Коммерческое название.
slug
string
Slug модели.
description
string | null
Описание.
vram_gb
number
Видеопамять на одну карту.
created_at
string
Дата создания.
updated_at
string
Дата обновления.
provider
object
Данные о провайдере:
id
string
ID провайдера.
slug
string
Slug.
name
string
Название.
created_at
string
Дата создания.
updated_at
string
Дата обновления.
base_image
object
Информация о базовом образе ОС:
id
string
ID образа.
name
string
Название (например, Ubuntu 24.04).
description
string | null
Описание ОС.
logo_url
string | null
Ссылка на логотип.
os_type
string
Тип ОС (linux/windows).
distro_version
string
Версия дистрибутива.
driver_version
string | null
Версия видеодрайвера.
cuda_version
string | null
Версия CUDA.
supports_docker
boolean
Поддержка Docker.
supports_rdp
boolean
Поддержка RDP.
specs
json | null
Технические спецификации ПО.
sort_order
number
Порядок сортировки при выводе.
ssh_keys
array
Список SSH-ключей, добавленных на этот сервер:
id
string
Уникальный идентификатор ключа в нашей системе.
name
string
Заданное вами имя ключа.
public_key
string
Сохраняемый публичный ключ.
fingerprint
string | null
Хеш (отпечаток) ключа для быстрой проверки идентичности.
is_default
boolean
Является ли ключ основным для новых инстансов.
created_at
string
Дата добавления ключа в формате ISO 8601.
updated_at
string
Дата последнего обновления ключа в формате ISO 8601.
paid_until
string | null
Дата, до которой оплачен инстанс.
last_billed_at
string | null
Дата последнего успешного списания средств.
started_at
string | null
Дата фактического запуска сервера провайдером.
terminated_at
string | null
Дата удаления инстанса.
created_at
string
Дата создания записи об инстансе.
updated_at
string
Дата последнего обновления записи.
Есть вопросы?
Поддержка Чат
Нашли ошибку? Сообщить