Spectra Logic

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

Get Storage Domain Capacity Summary

Description

Get the capacity summary for the specified storage domain. Use parameters as selection criteria to return capacity information for a portion of the storage domain.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/capacity_summary​?storage_domain_id={string}[&pool_health=OK|DEGRADED]​[&pool_state=BLANK|NORMAL|LOST|FOREIGN|IMPORT_PENDING|​IMPORT_IN_PROGRESS][&pool_type=NEARLINE|ONLINE]​[&tape_state=NORMAL|BAD|BAR_CODE_MISSING|DATA_CHECKPOINT_MISSING| EJECT_FROM_EE_PENDING|EJECT_TO_EE_IN_PROGRESS|EJECTED|FOREIGN| FORMAT_IN_PROGRESS|FORMAT_PENDING|IMPORT_IN_PROGRESS|INCOMPATIBLE|INSPECTION_PENDING|LOST|LTFS_WITH_FOREIGN_DATA|OFFLINE| ONLINE_IN_PROGRESS|ONLINE_PENDING|SERIAL_NUMBER_MISMATCH|UNKNOWN]​[&tape_type=LTO5|LTO6|LTO7|LTO8|LTOM8|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
storage_domain_id	The UUID for the storage domain assigned to the bucket.	yes
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
tape_type	The tape format and generation of the tape cartridge. Values: LTO5, LTO6, LTO7, LTO8, LTOM8, 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>
      <PhysicalFree>{64‑bit integer}</PhysicalFree>
      <PhysicalUsed>{64‑bit integer}</PhysicalUsed>
   </Pool>
   <Tape>
      <PhysicalAllocated>{64‑bit integer}</PhysicalAllocated>
      <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 for all pools in the storage domain.
PhysicalAllocated	The physical capacity currently allocated, in bytes.
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 in the storage domain.

Example

Sample Request

This request gets the capacity summary for the storage domain named “accounting”.

GET http://blackpearl-hostname/_rest_/capacity_summary​?storage_domain_id=accounting HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Pool>
      <PhysicalAllocated>1500</PhysicalAllocated>
      <PhysicalFree>1000</PhysicalFree>
      <PhysicalUsed>500</PhysicalUsed>
   </Pool>
   <Tape>
      <PhysicalAllocated>1501</PhysicalAllocated>
      <PhysicalFree>1000</PhysicalFree>
      <PhysicalUsed>501</PhysicalUsed>
   </Tape>
</Data>