Endpoint

/v1/files/{ref}/aggregates/

GET

Return aggregated data for a directory (like capacity, IOPS, etc.)

Parameters

Name Description Required
ref The file ID or the absolute path to the file system object. File IDs can be found in the id field of responses of APIs that return file attributes. You must URL-encode the paths. The APIs & Tools page in the Qumulo Core Web UI URL-encodes the paths. Yes
max-entries Maximum number of directory entries to return (defauilt: 1000) No
order-by Ordering field used for top N selection and sorting (default: total_blocks): * `total_blocks` - total_blocks, * `total_datablocks` - total_datablocks, * `total_directories` - total_directories, * `total_files` - total_files, * `total_metablocks` - total_metablocks, * `total_named_stream_datablocks` - total_named_stream_datablocks, * `total_named_streams` - total_named_streams, * `total_other` - total_other, * `total_symlinks` - total_symlinks No
snapshot The snapshot ID that specifies the version of the filesystem to use. If not specified, use the head version. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_files_dir_aggregates",
  "type": "object",
  "properties": {
    "path": {
      "description": "path",
      "type": "string"
    },
    "id": {
      "description": "id",
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "description": "files",
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of this file or directory",
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "FS_FILE_TYPE_FILE",
              "FS_FILE_TYPE_DIRECTORY",
              "FS_FILE_TYPE_SYMLINK",
              "FS_FILE_TYPE_UNIX_PIPE",
              "FS_FILE_TYPE_UNIX_CHARACTER_DEVICE",
              "FS_FILE_TYPE_UNIX_BLOCK_DEVICE",
              "FS_FILE_TYPE_UNIX_SOCKET"
            ],
            "description": "type:\n * `FS_FILE_TYPE_DIRECTORY` - FS_FILE_TYPE_DIRECTORY,\n * `FS_FILE_TYPE_FILE` - FS_FILE_TYPE_FILE,\n * `FS_FILE_TYPE_SYMLINK` - FS_FILE_TYPE_SYMLINK,\n * `FS_FILE_TYPE_UNIX_BLOCK_DEVICE` - FS_FILE_TYPE_UNIX_BLOCK_DEVICE,\n * `FS_FILE_TYPE_UNIX_CHARACTER_DEVICE` - FS_FILE_TYPE_UNIX_CHARACTER_DEVICE,\n * `FS_FILE_TYPE_UNIX_PIPE` - FS_FILE_TYPE_UNIX_PIPE,\n * `FS_FILE_TYPE_UNIX_SOCKET` - FS_FILE_TYPE_UNIX_SOCKET"
          },
          "id": {
            "description": "Unique ID of this file or directory",
            "type": "string"
          },
          "capacity_usage": {
            "description": "Capacity used by this file, or directory and all its children, in bytes",
            "type": "string"
          },
          "data_usage": {
            "description": "Capacity used for data by this file, or directory and all its children, in bytes",
            "type": "string"
          },
          "meta_usage": {
            "description": "Capacity used for metadata by this file, or directory and all its children, in bytes",
            "type": "string"
          },
          "num_files": {
            "description": "Total number of files in the directory",
            "type": "string"
          },
          "num_directories": {
            "description": "Total number of directories in the directory",
            "type": "string"
          },
          "num_symlinks": {
            "description": "Total number of symlinks in the directory",
            "type": "string"
          },
          "num_other_objects": {
            "description": "Total number of Unix devices, pipes, and sockets in the directory",
            "type": "string"
          },
          "named_stream_data_usage": {
            "description": "Capacity used for data by named streams on this file, or directory and all its children, in bytes",
            "type": "string"
          },
          "num_named_streams": {
            "description": "Total number of named streams in the directory",
            "type": "string"
          }
        }
      }
    },
    "total_capacity": {
      "description": "total_capacity",
      "type": "string"
    },
    "total_data": {
      "description": "total_data",
      "type": "string"
    },
    "total_named_stream_data": {
      "description": "total_named_stream_data",
      "type": "string"
    },
    "total_meta": {
      "description": "total_meta",
      "type": "string"
    },
    "total_files": {
      "description": "total_files",
      "type": "string"
    },
    "total_directories": {
      "description": "total_directories",
      "type": "string"
    },
    "total_symlinks": {
      "description": "total_symlinks",
      "type": "string"
    },
    "total_other_objects": {
      "description": "total_other_objects",
      "type": "string"
    },
    "total_named_streams": {
      "description": "total_named_streams",
      "type": "string"
    }
  }
}