API HTTP et tableau de bord de Keeper

Documentation de l’API HTTP de ClickHouse Keeper et du tableau de bord web intégré

ClickHouse Keeper fournit une API HTTP et un tableau de bord web intégré pour la surveillance, les contrôles d’état et la gestion du stockage. Cette interface permet aux opérateurs d’inspecter l’état du cluster, d’exécuter des commandes et de gérer le stockage de Keeper depuis un navigateur web ou via des clients HTTP.

​

Configuration

Pour activer l’API HTTP, ajoutez la section http_control à la configuration keeper_server :

<keeper_server>
    <!-- Other keeper_server configuration -->

    <http_control>
        <port>9182</port>
        <!-- <secure_port>9443</secure_port> -->
    </http_control>
</keeper_server>

​

Options de configuration

Paramètre	Par défaut	Description
http_control.port	-	Port HTTP du tableau de bord et de l’API
http_control.secure_port	-	Port HTTPS (nécessite une configuration SSL)
http_control.readiness.endpoint	/ready	Chemin personnalisé de la sonde de disponibilité
http_control.storage.session_timeout_ms	30000	Délai d’expiration de la session pour les opérations de l’API de stockage

​

Endpoints

​

Tableau de bord

• Chemin: /dashboard
• Méthode: GET
• Description: Expose un tableau de bord web intégré pour surveiller et gérer Keeper

Le tableau de bord comprend :

• Visualisation en temps réel de l’état du cluster
• Surveillance des nœuds (rôle, latence, connexions)
• Explorateur de stockage
• Interface d’exécution des commandes

​

Sonde de disponibilité

• Chemin : /ready (configurable)
• Méthode : GET
• Description : endpoint de contrôle de l’état de santé

Réponse en cas de succès (HTTP 200) :

{
  "status": "ok",
  "details": {
    "role": "leader",
    "hasLeader": true
  }
}

​

API des commandes

• Chemin: /api/v1/commands/{command}
• Méthodes: GET, POST
• Description: Exécute des commandes Four-Letter Word ou des commandes de la CLI ClickHouse Keeper Client

Paramètres de requête :

• command - La commande à exécuter
• cwd - Répertoire de travail courant pour les commandes basées sur un chemin (par défaut : /)

Exemples :

# Four-Letter Word command
curl http://localhost:9182/api/v1/commands/stat

# ZooKeeper CLI command
curl "http://localhost:9182/api/v1/commands/ls?command=ls%20'/'&cwd=/"

​

API de stockage

• Chemin de base: /api/v1/storage
• Description: API REST pour les opérations de stockage de Keeper

L’API de stockage suit les conventions REST, où les méthodes HTTP indiquent le type d’opération :

Opération	chemin	Méthode	Code d’état	Description
Récupérer	/api/v1/storage/{path}	GET	200	Récupérer les données du nœud
Lister	/api/v1/storage/{path}?children=true	GET	200	Lister les nœuds enfants
Vérifier l’existence	/api/v1/storage/{path}	HEAD	200	Vérifier si le nœud existe
Créer	/api/v1/storage/{path}	POST	201	Créer un nouveau nœud
Mettre à jour	/api/v1/storage/{path}?version={v}	PUT	200	Mettre à jour les données du nœud
Supprimer	/api/v1/storage/{path}?version={v}	DELETE	204	Supprimer le nœud