Enterprise File Storage - Premiers pas avec les API
Débuter sur votre offre Enterprise File Storage à l’aide des API OVHcloud
Dernière mise à jour le 27/10/2021
Objectif
Dans ce guide de démarrage rapide, découvrez comment débuter sur votre offre Enterprise File Storage.
Vous apprendrez comment récupérer les informations de votre offre et créer votre premier volume à l'aide des API OVHcloud.
Prérequis
- Disposer d'une offre OVHcloud Enterprise File Storage
- Être connecté sur la page des API OVHcloud
- Savoir monter un partage NFS
L'essentiel
L'offre OVHcloud Enterprise File Storage vous permet de créer des volumes et de gérer ainsi des partages de fichiers accessibles sur un réseau.
Vous avez la possibilité de choisir la taille de vos volumes, gérer les accès via des ACL ou encore créer des snapshots (copie instantanée du volume).
En pratique
Toutes les API utilisées pour ce guide sont disponibles dans la section /storage : https://api.ovh.com/console/#/storage.
Lors de l'utilisation des API, tous les champs marqués d'un astérisque (*) sont obligatoires.
Récupérer les informations de votre service
Tous vos services actifs peuvent être récupérés en utilisant la route API suivante :
Créer un nouveau volume
Un volume est une unité de stockage avec une taille et un protocole.
Pour créer un volume, utilisez la route API suivante :
- API :
- Paramètres :
-
serviceName *
ID du service
NetAppShare *
description
Description du volume
name
Nom du volume
protocole *
Protocole utilisé par le volume
size
Taille en gigaoctets du volume
Sélectionnez le protocole NFS et une taille de 10 gigaoctets par exemple.
Ajouter une ACL au volume
Les ACLs permettent d'autoriser ou de refuser l'accès à un volume.
Le comportement par défaut consiste à refuser tout accès à un nouveau volume.
Après avoir créé un volume, vous devez créer une nouvelle ACL afin d'accéder à celui-ci.
Pour créer une nouvelle ACL qui vous permettra de vous connecter à votre volume, utilisez la route API suivante :
- API :
- Paramètres :
-
serviceName *
ID du service
shareId *
ID du volume
NetAppShareACLRule *
accessLevel *
Niveau d'accès ACL. Peut être rw (lecture et écriture) ou ro (lecture seule).
accessTo *
Adresse IP ou plage d'adresses IP en notation CIDR.
En utilisant la notation CIDR, vous pouvez autoriser l'accès au volume depuis la plage d'adresses IP X.X.X.X/X. Par exemple: 192.0.2.0/24
Monter le volume
Vérifiez le statut de création de l'ACL à l'aide de la route API suivante :
- API :
- Paramètres :
-
serviceName *
ID du service
shareId *
ID du volume
aclRuleId *
ID de l'ACL
Remplacez aclRuleId par l'ID de l'ACL créée pour votre volume.
Le statut ACL doit être active.
Une fois que l'ACL est active, récupérez les chemins d'accès du volume à l'aide de l'API suivante :
- API :
- Paramètres :
-
serviceName *
ID du service
shareId *
ID du volume
Un ou plusieurs chemins d'accès vous seront présentés pour votre volume.
Vous pouvez maintenant monter le volume avec la commande suivante :
mount -t nfs accessPath
Si vous utilisez Linux, le paquet nfs-utils doit être installé.
Une fois monté, votre volume est alors utilisable pour stocker vos fichiers.
Suppression du volume
Vous pouvez supprimer votre volume à l'aide de la route API suivante :
- API :
- Paramètres :
-
serviceName *
ID du service
shareId *
ID du volume
Aller plus loin
Rejoignez notre communauté d'utilisateurs sur https://community.ovh.com/.
Cette documentation vous a-t-elle été utile ?
N’hésitez pas à nous proposer des suggestions d’amélioration afin de faire évoluer cette documentation.
Images, contenu, structure… N’hésitez pas à nous dire pourquoi afin de la faire évoluer ensemble !
Vos demandes d’assistance ne seront pas traitées par ce formulaire. Pour cela, utilisez le formulaire "Créer un ticket" .
Merci beaucoup pour votre aide ! Vos retours seront étudiés au plus vite par nos équipes..