Швидкий старт
Ця інструкція за кілька викликів API проведе вас від акаунта, з яким ви ввійшли в дашборд, до запущеної віртуальної машини. Усе, що ви тут робите, можна скасувати: видаліть VM, коли закінчите. VM тарифікується від створення до видалення, тож не залишайте її запущеною випадково; ціни наведено на сторінці Дані про ціни.
Перш ніж почати
Вам знадобляться три речі:
- Акаунт NimbusNexus. Зареєструйтеся на nimbusnexus.net.
- Утиліта командного рядка
curlабо будь-який HTTP-клієнт на ваш вибір, а такожjq, щоб читати відповіді. Приклади на цій сторінці використовуютьcurl; ті самі виклики працюють будь-якою мовою. - Близько пʼяти хвилин.
Налаштовувати SSH поки не потрібно: ця VM завантажується без ключа. Щоб згодом входити у VM, спершу зареєструйте ключ (SSH-ключі) і вкажіть його в sshs під час створення VM.
1 · Згенеруйте API-ключ
Увійдіть у дашборд і відкрийте Безпека → API-токени → Створити токен. Дайте токену назву, яку згодом упізнаєте (напр. quickstart), і виберіть область дії Адміністрування — з нею створюється необмежений ключ. З двома іншими областями дії створюється ключ без правил доступу, і такий ключ може лише прочитати власну сесію. Скопіюйте значення з підписом API-ключ, а не Секрет, у надійне місце — воно показується лише один раз.
Експортуйте його як змінну середовища, щоб приклади нижче могли на неї посилатися:
export NIMBUS_KEY="<your-api-key>"Надсилайте його в заголовку X-API-Key у кожному виклику. API-ключі привʼязані до одного проєкту. Поки що вистачить проєкту за замовчуванням, створеного разом із вашим акаунтом. Автентифікація описує ключі, обмежені лише потрібними їм викликами.
2 · Перегляньте доступні варіанти
Сьогодні NimbusNexus обслуговує один регіон — у Франкфурті, Німеччина, тож регіон вибирати не потрібно; подробиці наведено на сторінці Регіони. Запитайте в API, що ви можете там створити:
curl -s https://api.nimbusnexus.net/api/v1/instance/artifacts \
-H "X-API-Key: $NIMBUS_KEY" \
| jq '.data | {
images: [.images.data[] | { id, name }],
vm_options: [.vm_options.data[] | { architecture: .label, vm_classes: [.children[]?.label] }],
networks: [.networks.data[] | { id, name, external, subnets: [.subnets[].cidr] }],
security_groups: [.security_groups.data[] | { id, name }]
}'Тип тому завантажувального диска повертає другий виклик:
curl -s https://api.nimbusnexus.net/api/v1/storage/artifacts \
-H "X-API-Key: $NIMBUS_KEY" \
| jq '[.data.volume_options.data[].label]'Виберіть по одному значенню кожного виду й експортуйте їх. Образи, мережі та групи безпеки вказуються за id; архітектури, класи VM і типи томів — за міткою. Виберіть мережу з external: false, яка має підмережу: для приєднання до зовнішньої мережі потрібні також bandwidth_mbps і subscription.bandwidth, а без них виклик відповідає 400.
export IMAGE_ID="<image-id>"
export ARCHITECTURE="<architecture>"
export VM_CLASS="<vm-class>"
export VOLUME_TYPE="<volume-type>"
export NETWORK_ID="<network-id>"
export SECURITY_GROUP_ID="<security-group-id>"3 · Створіть першу VM
Конфігурація VM — це кількість cpu і обсяг ram у MB. Її завантажувальний диск має volume_size GB. Запустіть VM з одним vCPU, 2 GB RAM і диском на 25 GB:
curl -X POST https://api.nimbusnexus.net/api/v1/instance/ \
-H "X-API-Key: $NIMBUS_KEY" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"quickstart\",
\"image\": \"$IMAGE_ID\",
\"spec\": {
\"architecture\": \"$ARCHITECTURE\",
\"vm_class\": \"$VM_CLASS\",
\"cpu\": 1,
\"ram\": 2048,
\"volume_type\": \"$VOLUME_TYPE\"
},
\"volume_size\": 25,
\"network\": [\"$NETWORK_ID\"],
\"security_group\": [\"$SECURITY_GROUP_ID\"]
}"На конфігурацію, якої немає для цієї архітектури й класу, виклик відповідає 400; доступні конфігурації перелічує сторінка Дані про ціни. В іншому разі виклик ставить роботу в чергу й відповідає без ідентифікатора:
{
"success": true
}Знайдіть нову VM за назвою й прочитайте її status:
curl -s https://api.nimbusnexus.net/api/v1/instance/ \
-H "X-API-Key: $NIMBUS_KEY" \
| jq '.data[] | select(.name == "quickstart") | { id, status, nics, fault }'Спершу status — це BUILD, потім ACTIVE, а адреси VM містяться в nics:
{
"id": "3f0c9e1a-6b7d-4c2e-9a51-7d2b8f4e1c60",
"status": "ACTIVE",
"nics": {
"my-network": [
{ "addr": "10.0.0.12", "version": 4, "OS-EXT-IPS:type": "fixed" }
]
},
"fault": null
}Час від часу опитуйте VM, доки status не стане ACTIVE. Якщо це ERROR, fault пояснює, що пішло не так. Збережіть ідентифікатор:
export VM_ID="<vm-id>"Що ви зробили
Ви створили API-ключ, переглянули доступні варіанти й розгорнули справжню віртуальну машину. Багато ресурсів працюють так само: виклик artifacts перелічує доступні варіанти, POST створює, а GET читає. Видалення залежить від ресурсу, тож перевіряйте його сторінку в довіднику. API-ключ і заголовок однакові всюди на api.nimbusnexus.net.
Наступні кроки
- Перегляньте Довідник API, щоб побачити всі ендпоінти з параметрами, схемами запитів і відповідей та кодами помилок.
- Підʼєднайте плаваючий IP, щоб VM була доступна з інтернету.
- Прочитайте сторінку Автентифікація, щоб зрозуміти, як API-ключі працюють разом із привʼязкою до проєктів, ролями й правилами доступу.
- Прочитайте сторінку Угоди, щоб дізнатися правила, яких дотримується API, — пагінація, формати помилок, робота, що завершується після відповіді.
- Спробуйте інтерактивний оглядач API на api.nimbusnexus.net/docs/external — це Swagger UI, підʼєднаний до робочого API; «Try it out» робить справжні виклики у вашому акаунті.
Коли закінчите, видаліть VM, щоб за неї більше не нараховувалася плата. Разом із нею видаляється її завантажувальний том:
curl -X POST https://api.nimbusnexus.net/api/v1/instance/action \
-H "X-API-Key: $NIMBUS_KEY" \
-H "Content-Type: application/json" \
-d "{ \"servers\": [\"$VM_ID\"], \"cmd\": \"delete\" }"