Aller au contenu
NimbusNexus

Stockage en bloc

Les volumes block sont des disques persistants que vous attachez à des VM. Chaque volume vit dans la région de votre session ; un volume de données survit à la VM à laquelle il est attaché (vous pouvez le détacher puis le rattacher à une nouvelle VM) ; les volumes peuvent être agrandis ; et vous pouvez en prendre un snapshot ou une sauvegarde via Sauvegardes.

Types de volume

GET /api/v1/storage/artifacts liste ce que vous pouvez créer dans la région de votre session : les types de volume dans types, et les options de stockage tarifées dans volume_options. POST /api/v1/storage/ prend la size en GB et le volume_type, l’un des libellés de volume_options, qui fixe le prix. Les champs facultatifs sont un type issu de types, un name, une description, une image à partir de laquelle construire le volume, et subscription, le plan de facturation (Hourly par défaut).

Un volume conserve son type toute sa vie : aucun appel ne permet de le changer. Les prix par volume_type se trouvent dans Données tarifaires.

Cycle de vie

POST /api/v1/storage/ met le travail en file d’attente et répond sans identifiant ; le nouveau volume apparaît dans GET /api/v1/storage/. Son status provient du service de stockage en bloc. Les valeurs que vous rencontrerez le plus souvent :

  • available — créé mais pas attaché. Facturé comme un volume attaché (le stockage ne fait pas la différence).
  • in-use — lié à une VM. Visible dans la VM comme périphérique bloc (/dev/vdb, /dev/vdc, …).
  • detaching → available — en cours de libération d’une VM. Démontez le système de fichiers dans la VM avant de détacher le volume.

Le détachement est un appel distinct de la suppression. Supprimer une VM supprime le volume de démarrage créé à partir de son image ; les volumes que vous avez attachés, ou passés dans volumes lors de la création de la VM, restent available.

DELETE /api/v1/storage/ détruit les volumes dont vous listez les identifiants dans ids. Un volume supprimé est impossible à récupérer : sauvegardez-le donc d’abord si vous voulez une copie récupérable. Avec cascade: true, les snapshots du volume sont supprimés en même temps que lui.

Redimensionner

POST /api/v1/storage/resize avec {"volume_id": "…", "new_size": 500} agrandit un volume à 500 GB. new_size doit être supérieur à la taille actuelle ; pour toute autre valeur, l’API répond 400. Le système de fichiers de la VM a besoin d’un appel séparé à resize2fs / xfs_growfs pour occuper le nouvel espace.

La réduction n’est pas possible. Pour réduire la taille : créez un nouveau volume plus petit, attachez-le, copiez les données et détachez l’ancien.

Snapshots

Les snapshots et sauvegardes d’un volume se font via Sauvegardes : POST /api/v1/backup_restore/volume_backups/create_backup avec le volume_id et type: snapshot (une copie à un instant T conservée avec le volume) ou type: backup (une copie complète distincte).

Le snapshot est cohérent au niveau de la couche bloc, pas de la couche applicative. Pour une base de données, suspendez d’abord les écritures ou utilisez l’outil de sauvegarde propre à la base. Les snapshots de la couche bloc conviennent aux volumes de système de fichiers qui ne font pas tourner de moteur transactionnel.

Une restauration remet la copie à la place du volume, à la même taille ; voir Sauvegardes.

Sémantique d’attachement

Un volume ne peut être attaché qu’à une seule VM à la fois. Le multi-attachement (sémantique de disque partagé) n’est pas pris en charge.

POST /api/v1/storage/attach prend le volume_id, l’instance_id et un mountpoint facultatif ; sans mountpoint, le volume reçoit le premier périphérique libre à partir de /dev/vdb. POST /api/v1/storage/detach prend l’instance_id, le volume_id et l’attachment_id, que GET /api/v1/storage/detach_artifacts liste pour une VM.

Un volume et la VM à laquelle il s’attache se trouvent tous deux dans la région de votre session.

Notes sur les tarifs

  • Stockage : facturé au GB au prix du volume_type du volume, selon le plan indiqué dans subscription. Les prix se trouvent dans Données tarifaires.
  • Pas de facturation à l’IOPS. Pas de frais par attachement. Pas de supplément lié au débit.

Étapes suivantes

  • Machines virtuelles — ce à quoi vous attachez les volumes.
  • Stockage objet — pour les données non structurées qui n’ont pas besoin d’un accès au niveau bloc (logs, sauvegardes, fichiers téléversés par les utilisateurs).
  • Sauvegardes — les snapshots et sauvegardes d’un volume, et leur restauration.

Reference

GET/api/v1/storage/

Volumes List

Lists block storage volumes visible to the caller, optionally scoped to a specific project for administrators.

Parameters

NameInTypeDescription
admin_domainquerystring | null—
admin_projectquerystring | null—
projectquerystring | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

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

Volumes Create

Creates a new block storage volume in the user's project with the specified type, size and optional source image.

Request body

FieldTypeDescription
product_categorystringProduct category for billing
subscriptionobjectSubscription plan type
volume_type*stringStorage medium used for the volume
size*integer—
namestring | null—
descriptionstring | null—
typestring | null—
imagestring | null—

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/storage/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_type": "example",
    "size": 1
  }'
DELETE/api/v1/storage/

Volumes Delete

Deletes one or more block storage volumes by ID, optionally cascading to dependent resources.

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
projectstring | null—
ids*array of string—
cascadeboolean—

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/storage/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "example"
    ]
  }'
GET/api/v1/storage/artifacts

Volumes Artifacts

Returns the artifacts needed to create a block storage volume, including images, volume types and pricing options.

Parameters

NameInTypeDescription
admin_domainquerystring | null—
admin_projectquerystring | null—
product_type_namequerystring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

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

Volumes Attach

Attaches a block storage volume to a compute instance at the specified or next available mount point.

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
projectstring | null—
volume_id*string—
instance_id*string—
mountpointstring | null—
modestring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/storage/attach" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_id": "<volume_id>",
    "instance_id": "<instance_id>"
  }'
GET/api/v1/storage/attach_artifacts

Volumes Attach Artifacts

Returns artifacts needed to attach a volume to an instance, including available volumes, used mount points and the next free mount path.

Parameters

NameInTypeDescription
admin_domainquerystring | null—
admin_projectquerystring | null—
projectquerystring | null—
instance_id*querystring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/storage/attach_artifacts?instance_id=%3Cinstance_id%3E" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/storage/detach

Volumes Detach

Detaches a block storage volume from the specified compute instance.

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
projectstring | null—
instance_id*string—
volume_id*string—
attachment_id*string—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/storage/detach" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_id": "<instance_id>",
    "volume_id": "<volume_id>",
    "attachment_id": "<attachment_id>"
  }'
GET/api/v1/storage/detach_artifacts

Volumes Detach Artifacts

Returns the list of volumes currently attached to an instance to support detach selection.

Parameters

NameInTypeDescription
admin_domainquerystring | null—
admin_projectquerystring | null—
projectquerystring | null—
instance_id*querystring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/storage/detach_artifacts?instance_id=%3Cinstance_id%3E" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/storage/resize

Volumes Resize

Extends an existing block storage volume to a larger size.

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
projectstring | null—
volume_id*string—
new_size*integer—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/storage/resize" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "volume_id": "<volume_id>",
    "new_size": 1
  }'
PATCH/api/v1/storage/{volume_id}

Volume Update

Updates the editable attributes of a block storage volume identified by its ID.

Parameters

NameInTypeDescription
volume_id*pathstring—

Request body

FieldTypeDescription
namestring | null—
descriptionstring | null—
metadataobject | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/storage/<volume_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 →