Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Cache Filesystems

Description

Gets information about all cache filesystems.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/cache_filesystem/[?last_page][&page_length={32-bit integer}][&page_offset={32-bit integer}] [&page_start_marker={string}] [&node_id={string}]

Request Parameters

Parameter	Description	Required
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of cache filesystems to list. Default: all items after page_offset.	no
page_offset	The starting point for the first filesystem to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page _start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
node_id a	The UUID, DNS name, or other unique attribute for the node associated with the cache.	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <CacheFilesystem>
      <AutoReclaimInitiateThreshold>
         {double}
      </AutoReclaimInitiateThreshold>
      <AutoReclaimTerminateThreshold>
         {double}
      </AutoReclaimTerminateThreshold>
      <BurstThreshold>{double}</BurstThreshold>
      <Id>{string}</Id>
      <MaxCapacityInBytes>{64-bit integer}</MaxCapacityInBytes>
      <MaxPercentUtilizationOfFilesystem>
         {double}
      </MaxPercentUtilizationOfFilesystem>

      <NodeId>{string}</NodeId>
      <Path>{string}</Path>
   </CacheFilesystem>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
CacheFilesystem	A container for information about the cache filesystem.
AutoReclaim InitiateThreshold	The percentage full at which cache reclamation begins, expressed as a double-precision floating point number.
AutoReclaim Terminate Threshold	The percentage full at which cache reclamation terminates, expressed as a double-precision floating point number.
BurstThreshold	The percent utilization the cache must exceed to disable bursting, which permits the allocation of all cache resources on one job regardless of the job’s priority. Having a bust threshold below 1.0 ensures that one job does not prevent resources from being available for other jobs.
Id	The UUID for the cache filesystem.
MaxCapacityIn Bytes	The maximum capacity that can be used by the cache. Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
MaxPercent UtilizationOf Filesystem	The maximum capacity that can be used by the cache as a percentage of the total usable cache capacity. Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
NodeId	The UUID for the for the node associated with the cache.
Path	The path to the cache filesystem on the gateway.

Example

Sample Request

This request lists all cache filesystems.

GET http://blackpearl-hostname/_rest_/cache_filesystem/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <CacheFilesystem>
      <AutoReclaimInitiateThreshold>
         0.82
      </AutoReclaimInitiateThreshold>
      <AutoReclaimTerminateThreshold>
         0.72
      </AutoReclaimTerminateThreshold>
      <BurstThreshold>0.85</BurstThreshold>
      <Id>93c28334-e6b5-450e-ad7d-0380b706c5f4</Id>
      <MaxCapacityInBytes>524288000</MaxCapacityInBytes>
      <MaxPercentUtilizationOfFilesystem/>
      <NodeId>d1c919d5-70b5-4062-96b6-1000b2b56ee2</NodeId>
      <Path>
         /usr/local/BlackPearl/frontend/cachedir/
      </Path>
   </CacheFilesystem>

   ...
</Data>