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


Spectra BlackPearl Converged Storage System : Miscellaneous Operations : Cache Operations : Get Cache State

Get Cache State
Description
Gets the utilization information for all cache filesystems on the BlackPearl system.
Requests
Syntax
GET http[s]://{datapathDNSname}/_rest_/cache_state/
Responses
Response Elements
<Data>
   <Filesystems>
      <AvailableCapacityInBytes>
         {
64‑bit integer}
      </AvailableCapacityInBytes>
      <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>
      ...
      <Summary>{string}</Summary>
      <TotalCapacityInBytes>
          {64‑bit integer}
      </TotalCapacityInBytes>
      <UnavailableCapacityInBytes>
         {64‑bit integer}
      </UnavailableCapacityInBytes>
      <UsedCapacityInBytes>{64‑bit integer}</UsedCapacityInBytes>
   </Filesystems>
</Data>
where the response elements are defined as follows:
Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
Example
Sample Request
This request gets the state information for all cache filesystems.
GET http[s]://blackpearl-hostname/_rest_/cache_state/ HTTP/1.1
Sample Response
HTTP/1.1 200 OK
<Data>
   <Filesystems>
   <AvailableCapacityInBytes>54321</AvailableCapacityInBytes>
      <CacheFilesystem>
         <AutoReclaimInitiateThreshold>
            0.82
         </AutoReclaimInitiateThreshold>
         <AutoReclaimTerminateThreshold>
            0.72
         </AutoReclaimTerminateThreshold>
         <BurstThreshold>0.85</BurstThreshold>
         <Id>4322504e-556b-11e4-b466-080027200702</Id>
         <MaxCapacityInBytes>12345</MaxCapacityInBytes>
         <MaxPercentUtilizationOfFilesystem>
            0.8
         </MaxPercentUtilizationOfFilesystem>
         <NodeId>b9fd225a-ead8-41c7-b65b-71802c10d05a</NodeId>
         <Path>
            /usr/local/BlackPearl/frontend/cachedir/
         </Path>
      </CacheFilesystem>
      <Summary>summary message</Summary>
      <TotalCapacityInBytes>6789</TotalCapacityInBytes>
      <UnavailableCapacityInBytes>
         4321
      </UnavailableCapacityInBytes>
      <UsedCapacityInBytes>3456</UsedCapacityInBytes>
   </Filesystems>
</Data>