Sign in
storage

List disks

Changed on

Returns disk inventory across configured nodes. Unknown or unbounded remote capacity is represented with capacityKnown=false and null capacity fields rather than ClickHouse sentinel values.

get/storage/disks

Request

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

Query parameters

nodeIdstring
Example:shard1-replica1

Filter by movoor configured node id.

diskstring
Example:cold_disk

Filter by ClickHouse disk name.

typestring
Example:ObjectStorage

Filter by ClickHouse disk type. This is an open ClickHouse string.

brokenboolean

Filter disks by broken state.

Response

Disk inventory.

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",
      "disk": "cold_disk",
      "type": "ObjectStorage",
      "objectStorageType": "S3",
      "freeSpaceBytes": "104",
      "totalSpaceBytes": "104",
      "unreservedSpaceBytes": "104",
      "usedByActivePartsBytes": "104"
    }
  ]
}

Changes

  • ae109adee954Revision changes
    • breaking

      response property items/items/allOf[subschema #2]/cachePath list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/items/allOf[subschema #2]/path list-of-types was widened by adding types null to media type application/json of response 200

  • ddfd7d1ddb93Revision changes
    • info

      endpoint added