Aller au contenu principal

Clusters

L'endpoint /list/cluster de l'API Dashium vous permet d'obtenir la liste des clusters Docker enregistrés.

Cette route récupère les détails tels que le nom, l'icône, l'hôte, le port et d'autres informations pour chaque cluster.

Endpoint

  • Chemin : /list/cluster
  • Méthode : GET

Réponse

La réponse de cette route comprend une liste détaillée de tous les clusters enregistrés dans la base de données.

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

  • id : Identifiant unique du cluster.
  • name : Nom du cluster.
  • fullname : Nom complet du cluster avec une éventuelle icône.
  • icon : Icône représentant le cluster.
  • host : Adresse de l'hôte Docker.
  • port : Port d'accès à l'hôte Docker.
  • docker : Informations détaillées sur l'instance Docker du cluster, y compris le nombre de volumes.
{
"clusters": [
{
"id": 1,
"name": "NomCluster1",
"fullname": "💎 NomCluster1",
"icon": "💎",
"host": "localhost",
"port": 2376,
"docker": {
// Informations détaillées sur l'instance Docker du cluster
}
},
{
// ...
},
// ...
]
}

Exemple d'Utilisation

Effectuez une requête GET vers cette route pour récupérer la liste des clusters enregistrés.

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

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