Spectra Logic

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

Get Bucket Capacity Summary

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/capacity_summary/?bucket_id={string}&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|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
bucket_id	The UUID, name, or other unique identifier for the bucket.	yes
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
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>
      <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 for capacity information for a pool in the storage domain.
PhysicalAllocated	The physical capacity currently allocated, in bytes.
PhysicalFree	The physical capacity currently allocated, AND free (not used).
PhysicalUsed	The physical capacity currently used, in bytes. Note: The physical used + physical free = physical allocated.
Tape	The container for capacity information for tape partitions in the storage domain.

Example

Sample Request

This request gets the capacity summary for the bucket named “bucket1” on the storage domain named “LTO-5Tape”.

GET http://blackpearl-hostname/_rest_/capacity_summary/?bucket_id=bucket1&storage_domain_id=LTO-5Tape HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Pool>
      <PhysicalAllocated>0</PhysicalAllocated>
      <PhysicalFree>0</PhysicalFree>
      <PhysicalUsed>0</PhysicalUsed>
   </Pool>
   <Tape>
      <PhysicalAllocated>800</PhysicalAllocated>
      <PhysicalFree>200</PhysicalFree>
      <PhysicalUsed>600</PhysicalUsed>
   </Tape>
</Data>