Endpoint

/v1/files/{ref}/fetch-data

POST

Performs a server-side read of the specified file region to populate cluster caches. Does not return file contents.

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
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_files_fetch_data",
  "type": "object",
  "properties": {
    "offset": {
      "description": "The offset (in bytes) from where to begin fetching data.",
      "type": "string"
    },
    "length": {
      "description": "The maximum number of bytes to fetch. Equals to server target read size by default.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_files_fetch_data_result",
  "type": "object",
  "properties": {
    "bytes_fetched": {
      "description": "The number of bytes fetched into the cache.",
      "type": "string"
    },
    "next_offset": {
      "description": "The offset (in bytes) to use for the next fetch request. Empty at the end of the file.",
      "type": "string"
    }
  }
}