Sign in
tables

List table partitions

Changed on

Returns logical partition placement and active operation overlays. The partitionId field is ClickHouse system.parts.partition_id verbatim and is unique only within the database/table pair.

get/tables/{database}/{table}/partitions

Request

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

Path parameters

databasestring required
Example:movoor_dev

ClickHouse database name.

tablestring required
Example:test_generic_network_month_local

ClickHouse table name.

Query parameters

placement'on_target' | 'off_target' | 'split' | 'replica_divergent' | 'missing_replica' | 'unknown'

API-owned placement relative to the table's configured targetDisk. This is not a hot/cold tier vocabulary.

Filter partitions by API-owned target-disk placement. Invalid values return 400.

operationstring
Example:moving

Filter partitions by open operation overlay. Known values include moving, merging, mutating, and fetching. Unknown values are valid and return an empty result set when no matching overlay exists.

diskstring
Example:cold_disk

Filter by ClickHouse disk name.

nodeIdstring
Example:shard1-replica1

Filter by movoor configured node id.

shardstring
Example:shard1

Filter by shard id.

replicastring
Example:replica1

Filter by replica id.

partitionIdstring
Example:d82d64de29c8683be4aad2f0fd38d74e

Filter by ClickHouse partition_id verbatim. partitionId is URL-safe but unique only within the selected database and table.

hasConditionsboolean

Filter resources by whether movoor detected conditions.

Response

Partition placement state.

Example response

{
  "collection": {
    "warnings": [
      {
        "code": "node_unreachable",
        "message": "clickhouse-shard2-replica2 did not respond before timeout",
        "nodeId": "shard2-replica2"
      }
    ]
  },
  "items": [
    {
      "partition": "('mainnet','2026-01-08')",
      "partitionId": "d82d64de29c8683be4aad2f0fd38d74e",
      "activeParts": "104",
      "rows": "104",
      "bytesOnDisk": "104",
      "placements": [
        {
          "nodeId": "shard1-replica1",
          "shard": "shard1",
          "replica": "replica1",
          "activeParts": "104",
          "rows": "104",
          "bytesOnDisk": "104"
        }
      ],
      "conditions": [
        {
          "code": "replica_disk_mismatch"
        }
      ]
    }
  ]
}

Changes