Spectra Logic

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

Get Pools

Description

Get a list of all pools. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/pool​[?assigned_to_storage_domain=TRUE|FALSE][&bucket_id={string}][&health=OK|DEGRADED][&last_page]​[&name={string}][&page_length={32‑bit integer}][&page_offset={32‑bit integer}][&page_start_marker={string}]​[&partition_id={string}][&powered_on=TRUE|FALSE]​[&state=NORMAL|FOREIGN|IMPORT_IN_PROGRESS|IMPORT_PENDING|LOST]​[&storage_domain_id={string}][&type=NEARLINE|ONLINE]

Request Parameters

Parameter	Description	Required
assigned_to_ storage_domain	Whether the pool is currently assigned to a storage domain. Values: TRUE, FALSE	no
bucket_id	The UUID for the bucket to which the pool is assigned.	no
guid	The ZFS identifier for the pool.	no
health	Whether the pool is in good health or degraded. Values: OK, DEGRADED	no
last_page	If included, only the last page of results is returned.	no
last_verified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.	no
name a	The name assigned to the pool.	no
page_length	The maximum number of pools to list. The default is all items after page_offset.	no
page_offset	The starting point for the first pool to list. The default is 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
partition_id	The UUID for the partition.	no
powered_on	Whether the pool is powered on. This is always TRUE for pools with type=ONLINE. Values: TRUE, FALSE	no
state	The status of the pool. Values: BLANK, NORMAL, FOREIGN, IMPORT_IN_PROGRESS, IMPORT_PENDING, LOST. State.	no
storage_domain_id	The UUID for the storage domain to which the pool is assigned.	no
type	The type of pool. Values: NEARLINE (ArcticBlue), ONLINE (SAS)	no

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

Responses

Response Elements

<Data>

   <Pool>
      <AssignedToStorageDomain>
         TRUE|FALSE
      </AssignedToStorageDomain>
      <AvailableCapacity>{64‑bit integer}</AvailableCapacity>
      <BucketId>{string}</BucketId>
      <Guid>{string}</Guid>
      <Health>OK|DEGRADED</Health>
      <Id>{string}</Id>
      <LastAccessed>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastAccessed>
      <LastModified>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastModified>
      <LastVerified>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastVerified>
      <Mountpoint>/{string}</Mountpoint>
      <Name>{string}</Name>

      <PartitionId>{string}</PartitionId>
      <PoweredOn>TRUE|FALSE</PoweredOn>
      <Quiesced>NO|PENDING|YES</Quiesced>
      <ReservedCapacity>{64‑bit integer}</ReservedCapacity>

      <State>
         NORMAL|FOREIGN|IMPORT_IN_PROGRESS|IMPORT_PENDING|LOST
      </State>

      <StorageDomainId>{string}</StorageDomainId>
      <TotalCapacity>{64‑bit integer}</TotalCapacity>
      <Type>NEARLINE|ONLINE</Type>
      <UsedCapacity>{64‑bit integer}</UsedCapacity>
   </Pool>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
AssignedToStorageDomain	Whether the pool is currently assigned to a storage domain. Values: TRUE, FALSE
AvailableCapacity	The amount of unused capacity on the pool in bytes.
BucketId	The UUID for the bucket to which the pool is assigned.
Guid	The ZFS identifier for the pool.
Health	Whether the pool is in good health or degraded. Values: OK, DEGRADED
Id	The UUID for the pool.
LastAccessed	The last date and time the pool was accessed in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastModified	The last date and time an object in the pool was modified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastVerified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
MountPoint	The logical directory used by the BlackPearl system to access the pool.
Name	The name for the pool.
PartitionId	The UUID of the pool partition.
PoweredOn	Whether the pool is powered on. Values: TRUE, FALSE
Quiesced	Whether the pool is in a temporarily inactive state. Values: NO, PENDING, YES
ReservedCapacity	The capacity reserved to ensure pool performance.
State	The status of the pool. Values: BLANK, NORMAL, FOREIGN, IMPORT_IN_PROGRESS, IMPORT_PENDING, LOST. State.
StorageDomainId	The UUID for the storage domain to which the pool is assigned.
TotalCapacity	The total capacity of the pool including used, reserved and available capacity.
Type	The type of pool. Values: NEARLINE (ArcticBlue), ONLINE (SAS)
UsedCapacity	The amount of used capacity on the pool in bytes.

Example

Sample Request

This request retrieves information about all pools associated with the BlackPearl Converged Storage System.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Pool>
      <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
      <AvailableCapacity>10000</AvailableCapacity>
      <BucketId/>
      <Guid>6a0a51b0-8318-4945-a67a-c890c0ab92de</Guid>
      <Health>OK</Health>
      <Id>a124e769-be69-4ae5-8846-9a58f40d28f1</Id>
      <LastAccessed/>
      <LastModified/>
      <LastVerified/>
      <Mountpoint>/mountpoint-0</Mountpoint>
      <Name>pool0</Name>
      <PartitionId/>
      <PoweredOn>TRUE</PoweredOn>
      <Quiesced>NO</Quiesced>
      <ReservedCapacity>0</ReservedCapacity>
      <State>NORMAL</State>
      <StorageDomainId/>
      <TotalCapacity>30000</TotalCapacity>
      <Type>NEARLINE</Type>
      <UsedCapacity>20000</UsedCapacity>
   </Pool>
   ...
</Data>