Перейти до вмісту
NimbusNexus

Бекапи

Бекап — це копія одного блокового тому на певний момент часу одного з двох типів: snapshot, який сервіс блокового сховища зберігає поряд із томом, або backup — окрема повна копія. Ви створюєте їх на вимогу або їх створює для вас розклад.

Бекапи чи снапшоти

І те, і інше — копії на певний момент часу; різняться вони тим, як працюють:

type: snapshottype: backup
Що цеСнапшот, що зберігається разом із томомОкрема повна копія, яку можна надіслати ще й у ваше власне сховище
СтворюєтьсяПрямим викликом або розкладомПрямим викликом або розкладом
Відновлюється черезPOST /api/v1/backup_restore/volume_backups/snapshot_restorePOST /api/v1/backup_restore/volume_backups/backup_restore

Снапшот належить своєму тому: видалення тому з cascade: true (DELETE /api/v1/storage/) видаляє і його снапшоти.

Створення копії

POST /api/v1/backup_restore/volume_backups/create_backup одразу копіює том. Укажіть volume_id і type (snapshot або backup), а також, за бажанням, name, description і permanent. Для backup параметр storage_ids додатково надсилає копію в підключення до зовнішніх сховищ, які ви налаштували через POST /api/v1/external/connections/.

Виклик ставить роботу в чергу й одразу відповідає — або відповідає 409, якщо копія не вміститься у вашу квоту на бекапи. GET /api/v1/backup_restore/volume_backups/ перелічує ваші копії з фільтрами backup_types і statuses, а також limit (за замовчуванням 10) і offset. status копії — це pending, in_progress, completed або failed.

Копії за розкладом

Розклад створює копії за вас. Створіть його через POST /api/v1/backup_restore/backup_scheduler/, указавши frequency і backup_quantity, а потім привʼяжіть до кожного тому через POST /api/v1/backup_restore/volume_scheduler/, указавши volume_id, schedule_id і type. Подробиці — на сторінці Заплановані бекапи.

Зберігання копій

Розклад зберігає backup_quantity найновіших копій (за замовчуванням 5) кожного привʼязаного до нього тому й видаляє старіші, коли зʼявляються нові; outside_backup_quantity (за замовчуванням 1) робить те саме для копій у кожному зовнішньому сховищі. Копії, створені на вимогу, зберігаються, доки ви їх не видалите.

Щоб вивести копію з цієї ротації, задайте для неї permanent: true — під час створення або пізніше через PATCH /api/v1/backup_restore/volume_backups/{volume_backup_id}.

Видаліть одну копію через DELETE /api/v1/backup_restore/volume_backups/single/{volume_backup_id} або кілька — через DELETE /api/v1/backup_restore/volume_backups/bulk, передавши їхні ідентифікатори в параметрі запиту backup_ids.

Відновлення

Відновіть снапшот через POST /api/v1/backup_restore/volume_backups/snapshot_restore, а бекап — через POST /api/v1/backup_restore/volume_backups/backup_restore. Обидва приймають {"backup_id": "…"}, ставлять роботу в чергу й одразу відповідають. Копія має бути в стані completed і того типу, який обслуговує ендпоінт; інакше виклик відповідає 409.

Відновлення відбувається на місці. Воно створює з копії новий том такого самого розміру й у тій самій зоні доступності, що й оригінал, і ставить його на місце оригіналу:

  • Том даних відʼєднується від своєї VM, а відновлений том підʼєднується на його місце.
  • Для завантажувального тому VM її перебудовують на відновленому диску. Нова VM переймає порти й плаваючі IP старої, а стару VM видаляють. VM отримує новий id; відновлений диск зберігає SSH-ключі, які на ньому були.

Копії й привʼязки до розкладів вихідного тому переходять до відновленого тому.

Що далі

Reference

GET/api/v1/backup_restore/volume_backups/

List Volume Backups

Lists volume backups for the project's volumes with filtering by status and type plus pagination and sorting.

Parameters

NameInTypeDescription
limitqueryinteger | null—
offsetqueryinteger | null—
statusesquerystring | null—
backup_typesquerystring | null—
sort_byquerystring | null—
sort_descqueryboolean—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/backup_restore/volume_backups/backup_restore

Run Backup Restore Queue Job

Queues a job that restores a completed volume backup back into a block storage volume.

Request body

FieldTypeDescription
backup_id*string—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/backup_restore" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backup_id": "<backup_id>"
  }'
DELETE/api/v1/backup_restore/volume_backups/bulk

Delete Volume Backup Bulk

Deletes multiple volume backups in one call, removing them from block storage and any external storage destinations.

Parameters

NameInTypeDescription
backup_ids*queryarray of string—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/bulk?backup_ids=%3Cbackup_id%3E" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/backup_restore/volume_backups/create_backup

Create Volume Backup Run Trigger

Queues a job that creates a new backup of a block storage volume after validating the project's quota.

Request body

FieldTypeDescription
namestring | null—
descriptionstring | null—
schedule_idstring | null—
schedule_config_idstring | null—
location_urlstring | null—
external_idstring | null—
storage_typestring | null—
regionstring | null—
volume_id*string—
type*website__model__website__volume_backup__volume_backup__BackupTypeEnum—
storage_idsarray of string | null—
statusobject—
permanentboolean—

Responses

  • 200Successful Response
  • 422Validation Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/create_backup" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_id": "<volume_id>",
    "type": "snapshot"
  }'
POST/api/v1/backup_restore/volume_backups/run_job_single

Volume Backup Run Trigger By Specific Conf

Request body

FieldTypeDescription
config_id*string—
name*string—
descriptionstring | null—
permanentboolean | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 422Validation error
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/run_job_single" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config_id": "<config_id>",
    "name": "Example"
  }'
POST/api/v1/backup_restore/volume_backups/schedule_job

Volume Backup Run Trigger By Schedule

Triggers the volume backup scheduler job for the requested frequency to evaluate due schedules.

Request body

FieldTypeDescription
frequency*"daily" | "weekly" | "monthly"—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 422Validation error
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/schedule_job" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "frequency": "daily"
  }'
DELETE/api/v1/backup_restore/volume_backups/single/{volume_backup_id}

Delete Volume Backup

Deletes a single volume backup from block storage and any associated external storage destinations.

Parameters

NameInTypeDescription
volume_backup_id*pathstring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/single/<volume_backup_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/backup_restore/volume_backups/snapshot_restore

Run Snapshot Restore Queue Job

Queues a job that restores a completed snapshot-type backup into a block storage volume.

Request body

FieldTypeDescription
backup_id*string—

Responses

  • 200Successful Response
  • 422Validation Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/snapshot_restore" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backup_id": "<backup_id>"
  }'
POST/api/v1/backup_restore/volume_backups/upload_exist

Upload Existing Volume Backup To Outside Storage

Queues jobs to upload an existing completed volume backup into one or more external storage destinations.

Request body

FieldTypeDescription
backup_id*string—
storage_idsarray of string | null—

Responses

  • 200Successful Response
  • 422Validation Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/upload_exist" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backup_id": "<backup_id>"
  }'
PATCH/api/v1/backup_restore/volume_backups/{volume_backup_id}

Update Volume Backup

Updates the editable attributes of an existing volume backup record.

Parameters

NameInTypeDescription
volume_backup_id*pathstring—

Request body

FieldTypeDescription
namestring | null—
descriptionstring | null—
permanentboolean | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/backup_restore/volume_backups/<volume_backup_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Need to make a real call? Try these endpoints in the live Swagger UI →