nodes

List configured nodes

Changed on

Returns configured ClickHouse nodes plus request-time reachability and coarse replication health. This endpoint is intentionally unpaginated: the collection is bounded by the configured node list.

get/nodes

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/nodes
  • Auth: none declared

Query parameters

nodeIdstring
Example:shard1-replica1

Filter by movoor configured node id.

Response

Nodes collected from the configured node list.

Example response

{
  "collection": {
    "warnings": [
      {
        "code": "node_unreachable",
        "message": "clickhouse-shard2-replica2 did not respond before timeout",
        "nodeId": "shard2-replica2"
      }
    ]
  },
  "items": [
    {
      "nodeId": "shard1-replica1",
      "shard": "shard1",
      "replica": "replica1",
      "endpoint": "clickhouse://clickhouse-shard1-replica1:9000",
      "version": "26.2.5.45",
      "timezone": "UTC",
      "uptimeSeconds": "104",
      "replication": {
        "queueSize": "104",
        "absoluteDelaySeconds": "104",
        "futureParts": "104",
        "totalReplicas": "104",
        "activeReplicas": "104"
      },
      "backgroundPools": {
        "mergesAndMutations": "104",
        "moves": "104",
        "fetches": "104"
      }
    }
  ]
}

Changes