Get System Capacity Summary

Get the BlackPearl Deep Storage Gateway system-wide capacity summary. Use parameters as selection criteria to return capacity information for a portion of the system.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/capacity_summary/[?pool_health={OK|DEGRADED}] [&pool_state={BLANK|NORMAL|LOST|FOREIGN|IMPORT_PENDING| IMPORT_IN_PROGRESS}][&pool_type={NEARLINE|ONLINE}] [&tape_state={NORMAL|OFFLINE|ONLINE_PENDING|ONLINE_IN_PROGRESS| PENDING_INSPECTION|UNKNOWN|DATA_CHECKPOINT_FAILURE| DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY|DATA_CHECKPOINT_MISSING| LTFS_WITH_FOREIGN_DATA|FOREIGN|IMPORT_PENDING| IMPORT_IN_PROGRESS|LOST|BAD|SERIAL_NUMBER_MISMATCH| BAR_CODE_MISSING|FORMAT_PENDING|FORMAT_IN_PROGRESS| EJECT_TO_EE_IN_PROGRESS|EJECT_FROM_EE_PENDING|EJECTED}] [&tape_type={LTO5|LTO6|LTO7|LTO_CLEANING_TAPE|TS_JC|TS_JY|TS_JK| TS_JD|TS_JZ|TS_JL|TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN}]

Request Parameters


Parameter	Description	Required
pool_health	The current health of the pool. Values: OK, DEGRADED.	no
pool_type	The type of pool. Values: NEARLINE (ArcticBlue), ONLINE (SAS)	no
pool_state	The status of the pool. See State.	no
tape_state	The status of the tape partition. See State.	no
Type	The tape format and generation of the tape cartridge. Values: LTO5, LTO6, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JD, TS_JK, TS_JL, TS_JY, TS_JZ, TS_CLEANING_TAPE, UNKNOWN, FORBIDDEN	no

Responses

Response Elements

<Data>
   <Pool>
      <PhysicalAllocated>{64-bit integer}</PhysicalAllocated>
      <PhysicalAvailable>{64-bit integer}</PhysicalAvailable>
      <PhysicalFree>{64-bit integer}</PhysicalFree>
      <PhysicalUsed>{64-bit integer}</PhysicalUsed>
   </Pool>
   <Tape>
      <PhysicalAllocated>{64-bit integer}</PhysicalAllocated>
      <PhysicalAvailable>{64-bit integer}</PhysicalAvailable>
      <PhysicalFree>{64-bit integer}</PhysicalFree>
      <PhysicalUsed>{64-bit integer}</PhysicalUsed>
   </Tape>
</Data>

where the response elements are defined as follows:


Parameter	Description
Data	The container for the response.
Pool	The container for capacity information across all pools.
PhysicalAllocated	The physical capacity currently allocated, in bytes.
PhysicalAvailable	The physical capacity not allocated, in bytes. (physical allocated + physical available = total physical capacity)
PhysicalFree	The physical capacity currently free (not used or allocated), in bytes.
PhysicalUsed	The physical capacity currently used, in bytes.
Tape	The container for capacity information for all tape partitions.

Example

Sample Request

This request gets the capacity summary for the BlackPearl Deep Storage Gateway.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Pool>
      <PhysicalAllocated>0</PhysicalAllocated>
      <PhysicalAvailable>0</PhysicalAvailable>
      <PhysicalFree>0</PhysicalFree>
      <PhysicalUsed>0</PhysicalUsed>
   </Pool>
   <Tape>
      <PhysicalAllocated>3000</PhysicalAllocated>
      <PhysicalAvailable>15000</PhysicalAvailable>
      <PhysicalFree>2000</PhysicalFree>
      <PhysicalUsed>1000</PhysicalUsed>
   </Tape>
</Data>