Aller au contenu principal

Containers

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

Utilisez cette route pour récupérer des détails sur tous les containers, y compris ceux qui sont actuellement en cours d'exécution.

Endpoint​

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

Réponse​

La réponse de cette route comprend une liste complète de tous les containers, ainsi qu'une sous-liste de ceux qui sont actuellement en cours d'exécution.

{
  "containers": [
    {
        "Id": "CONTAINER_ID",
        "Names": [
            "/CONTAINER_NAME"
        ],
        "Image": "CONTAINER_IMAGE",
        "ImageID": "CONTAINER_IMAGE_ID",
        "Command": "CONTAINER_CMD",
        "Created": "CONTAINER_CREATED_DATE",
        "Ports": [
            {
                "PrivatePort": 80,
                "Type": "tcp"
            }
        ],
        "Labels": {
            // ... ALL LABELS
        },
        "State": "running",
        "Status": "Up 5 hours",
        "HostConfig": {
            "NetworkMode": "default"
        },
        "NetworkSettings": {
            "Networks": {
                "ingress": {
                    "IPAMConfig": {
                        "IPv4Address": "CONTAINER_IPv4"
                    },
                    "Links": null,
                    "Aliases": null,
                    "NetworkID": "NETWORK_ID",
                    "EndpointID": "ENDPOINT_ID",
                    "Gateway": "",
                    "IPAddress": "IP_ADDRESS",
                    "IPPrefixLen": 24,
                    "IPv6Gateway": "",
                    "GlobalIPv6Address": "",
                    "GlobalIPv6PrefixLen": 0,
                    "MacAddress": "CONTAINER_MACADDRESS",
                    "DriverOpts": null
                }
            }
        },
        "Mounts": []
    },
    {
      // Détails du deuxième container
    },
    // ...
  ],
  "running": [
    {
        // Détails du container en cours d'exécution
    },
    // ...
  ]
}

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/containers

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