Sign in
tables

List active parts

Changed on

Returns physical parts from system.parts, per node.

get/tables/{database}/{table}/parts

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}/parts
  • 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

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.

partNamestring
Example:20260108_12_12_0

Filter by ClickHouse part name.

diskstring
Example:cold_disk

Filter by ClickHouse disk name.

activeboolean

Filter physical parts by active flag.

minBytesOnDiskstring

Exact unsigned 64-bit ClickHouse integer encoded as decimal text.

Example:104

Minimum bytes_on_disk filter for physical parts.

maxBytesOnDiskstring

Exact unsigned 64-bit ClickHouse integer encoded as decimal text.

Example:104

Maximum bytes_on_disk filter for physical parts.

Response

Active part inventory.

databasestring required
tablestring required

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",
      "rows": "104",
      "marks": "104",
      "bytesOnDisk": "104",
      "dataCompressedBytes": "104",
      "dataUncompressedBytes": "104",
      "marksBytes": "104",
      "primaryKeyBytesInMemory": "104",
      "primaryKeyBytesInMemoryAllocated": "104",
      "secondaryIndicesCompressedBytes": "104",
      "secondaryIndicesUncompressedBytes": "104",
      "secondaryIndicesMarksBytes": "104",
      "refcount": "104",
      "minBlockNumber": "0",
      "maxBlockNumber": "0",
      "level": "104",
      "dataVersion": "104",
      "conditions": [
        {
          "code": "replica_disk_mismatch"
        }
      ]
    }
  ]
}

Changes