Disk Share

Split the data disk between flow metadata and capture files

The data disk of the device holds both the flow metadata database and the capture files. The disk share defines which fraction of the usable disk space is reserved for metadata; the rest is available for capture files. The automatic cleanup removes the oldest metadata and capture files when their share is about to be exceeded.

API

• Get the disk share and the space usage

  • Path: /api/storage

  • Method: GET

  • Minimum user role: viewer

  • Response on success (200 OK):

    {
        "message": "Success",
        "data": {
            "metadata_share": 0.93,
            "total_disk_bytes": 3401371422719,
            "available_metadata_space_bytes": 3163275423129,
            "used_metadata_space_bytes": 122603257856,
            "available_capture_space_bytes": 238095999590,
            "used_capture_space_bytes": 200824094720
        }
    }

    • metadata_share - fraction of the usable disk reserved for metadata, 0.0 to 1.0
    • total_disk_bytes - usable disk space, 90 percent of the capacity of the data disk
    • available_metadata_space_bytes - space reserved for metadata, total_disk_bytes multiplied by metadata_share
    • used_metadata_space_bytes - space currently occupied by metadata; 0 if the metadata size cannot be read
    • available_capture_space_bytes - space reserved for capture files, total_disk_bytes minus the metadata reservation
    • used_capture_space_bytes - space currently occupied by capture files; 0 if the metadata size cannot be read
• Set the disk share

  • Path: /api/storage

  • Method: PUT

  • Minimum user role: operator

  • Request body:

    {
        "metadata_share": 0.75
    }

    • metadata_share - mandatory, 0.0 to 1.0; the factory default is 0.5

  • Response on success (200 OK): {"message": "Success", "data": {"metadata_share": 0.75}}

  • Response on failure (422 Unprocessable Entity): The 'metadata_share' key-value is missing. or The 'metadata_share' value is not valid. Expected double value between [0.0, 1.0].

  • Notes: the new share takes effect immediately and is kept across restarts. Lowering the share of a partition that is already fuller than its new reservation triggers the automatic cleanup, which deletes the oldest data of that partition.

Back to Index