Aller au contenu principal

Volumes

L'endpoint /list/:cluster/volumes de l'API Dashium vous permet d'obtenir la liste des volumes Docker pour un cluster spécifique.

Utilisez cette route pour récupérer des détails sur tous les volumes associés au cluster.

Endpoint​

  • Chemin : /list/:cluster/volumes
  • Méthode : GET
  • Paramètres :
    • :cluster (Nom du cluster Docker)

Réponse​

La réponse de cette route comprend une liste complète des volumes Docker associés au cluster spécifié.

Chaque élément de la liste contient les informations suivantes :

  • CreatedAt : Date et heure de création du volume.
  • Driver : Pilote utilisé pour gérer le volume (dans cet exemple, "local").
  • Labels : Étiquettes associées au volume.
  • Mountpoint : Point de montage du volume sur le système de fichiers hôte.
  • Name : Nom du volume.
  • Options : Options de configuration du volume (dans cet exemple, "null" car aucune option spécifiée).
  • Scope : Portée du volume (dans cet exemple, "local").
{
  "Volumes": [
    {
        "CreatedAt": "2023-12-12T13:49:36Z",
        "Driver": "local",
        "Labels": {
            "com.docker.volume.anonymous": ""
        },
        "Mountpoint": "/var/lib/docker/volumes/VOLUME_ID/_data",
        "Name": "VOLUME_NAME",
        "Options": null,
        "Scope": "local"
    },
    {
      // Détails du deuxième volume
    },
    // ...
  ]
}

Exemple d'Utilisation​

Effectuez une requête GET vers cette route en remplaçant :cluster par le nom du cluster Docker que vous souhaitez interroger.

curl -X GET https://votre-api-dashium.com/list/mon-cluster/volumes

En cas de succès, vous obtiendrez une réponse JSON détaillant les volumes.