Spectra Logic

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

Get Objects - Spectra S3

Description

Lists information about all objects. Use parameters as selection criteria to return information about a subset of the objects.

Note:

Selection criteria should always be used to reduce the size of the response. The full list can be very large and take a long time for the response.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/object/[?bucket_id={string}][&folder={text}][&full_details] [&include_physical_placement][&last_page] [&name={string}][&page_length={32-bit integer}]
[&page_offset={32-bit integer}][&page_start_marker={string}] [&type=DATA|FOLDER][&version={64-bit integer}]

Request Parameters

Parameter	Description	Required
bucket_id a	The UUID or name for a bucket.	no
folder	The UUID, path, or other unique attribute for the folder containing the object.	no
full_details	If included the ETag, owner and size of the object is included in the response.	no
include_physical_ placement	If included, the response includes physical placement information.	no
last_page	If included, only the last page of results is returned.	no
name a	The name of an object.	no
page_length	The maximum number of objects to list. The default is all items after page_offset.	no
page_offset	The starting point for the first object 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
type	The type of object. Values: DATA, FOLDER	no
version	The version number of an object.	no

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

Responses

Response Elements

With full_details:

<Data>
   <Object or S3Object>

      <Blobs> (only if include_physical_placement is included)
         <Object
            Latest="TRUE|FALSE"
            Length="{64-bit integer}"
            Name="{string}"
            Offset="{64-bit integer}"
            Version="{64-bit integer}">
            <PhysicalPlacement>
               <Pools>
                  <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>YES|NO|PENDING</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>
                  ...
               </Pools>

               <Tapes>
                  <Tape>
                     <AssignedToStorageDomain>
                        TRUE|FALSE
                     </AssignedToStorageDomain>
                     <AvailableRawCapacity>
                        {64-bit integer}
                     </AvailableRawCapacity>
                     <BarCode>{string}</BarCode>
                     <BucketId>{string}</BucketId>
                     <DescriptionForIdentification>
                        {string}
                     </DescriptionForIdentification>

                     <EjectDate>
                        {YYYY-MM-DDThh:mm:ss.xxxZ}
                     </EjectDate>
                     <EjectLabel>{string}</EjectLabel>
                     <EjectLocation>{string}</EjectLocation>
                     <EjectPending>
                        {YYYY-MM-DDThh:mm:ss.xxxZ}
                     </EjectPending>
                     <FullOfData>TRUE|FALSE</FullOfData>
                     <Id>{string}</Id>

                     <LastAccessed>
                        {YYYY-MM-DDThh:mm:ss.xxxZ}
                     </LastAccessed>
                     <LastCheckpoint>{string}</LastCheckpoint>
                     <LastModified>
                        {YYYY-MM-DDThh:mm:ss.xxxZ}
                     </LastModified>
                     <LastVerified>
                        {YYYY-MM-DDThh:mm:ss.xxxZ}
                     </LastVerified>
                     <PartitionId>{string}</PartitionId>

                     <PreviousState>
                        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|LOST|
                        LTFS_WITH_FOREIGN_DATA|OFFLINE|
                        ONLINE_IN_PROGRESS|ONLINE_PENDING|
                        PENDING_INSPECTION|SERIAL_NUMBER_MISMATCH|
                        UNKNOWN
                     </PreviousState>

                     <SerialNumber>{string}</SerialNumber>
                     <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|LOST|
                        LTFS_WITH_FOREIGN_DATA|OFFLINE|
                        ONLINE_IN_PROGRESS|ONLINE_PENDING|
                        PENDING_INSPECTION|SERIAL_NUMBER_MISMATCH|
                        UNKNOWN
                     </State>

                     <StorageDomainId>{string}</StorageDomainId>
                     <TakeOwnershipPending>
                        TRUE|FALSE
                     </TakeOwnershipPending><
                     <TotalRawCapacity>
                        {64-bit integer}
                     </TotalRawCapacity>
                     <Type>
                        LTO5|LTO6|LTO7|LTO_CLEANING_TAPE|TS_JC|
                        TS_JY|TS_JK|TS_JD|TS_JZ|TS_JL|
                        TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN
                     </Type>

                     <VerifyPending>
                        CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
                     </VerifyPending>
                     <WriteProtected>TRUE|FALSE</WriteProtected>
                  </Tape>
                  ...

               </Tapes>
            </PhysicalPlacement>
         </Object>
         ...
      </Blobs>

      <BlobsBeingPersisted>{string}</BlobsBeingPersisted>
         (only if include_physical_placement is included)
      <BlobsDegraded>{64-bit integer}</BlobsDegraded>
         (only if include_physical_placement is included)
      <BlobsInCache>{64-bit integer}</BlobsInCache>
         (only if include_physical_placement is included)
      <BlobsTotal>{64-bit integer}</BlobsTotal>
         (only if include_physical_placement is included)
      <BucketId>{string}</BucketId>
      <CreationDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</CreationDate>

      <ETag>{string}</ETag> (only if full_details is included)
      <Id>{string}</Id>
      <Latest>TRUE|FALSE</Latest>
      <Name>{string}</Name>
      <Owner>{string}</Owner>
         (only if full_details is included)
      <Size>{string}</Size> (only if full_details is included)
      <Type>DATA|FOLDER</Type>
      <Version>{64-bit integer}</Version>
   </Object or S3Object>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Object	The container for information about one object that was split into multiple blobs.
S3Object	The container for information about one object that was kept whole.
Blobs	The container for information about the blobs that are part of the object.
Object	The container for information about one blob.
Latest	Whether this version of the blob is the latest. Values: TRUE, FALSE
Length	The length in bytes of the blob.
Name	The name of the object.
Offset	The offset in bytes from the start of the object.
Version	The version number of the blob.
PhysicalPlacement	The container for information about the physical placement of the object on tape or in a pool.
Pools	The container for information about all pools.
Pool	The container for information about one pool.
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. If this attribute is null, then the object has not yet been completely received into cache.
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 gateway to access the pool.
Name	The name for the pool.
PartitionId	The UUID of the pool partition.
PoweredOn	Whether the pool is powered on. This is always TRUE for pools with type=ONLINE. Values: TRUE, FALSE
Quiesced	Whether the pool is in a temporarily inactive state. Values: YES, NO, PENDING
ReservedCapacity	The capacity reserved ensure pool performance.
State	The status of the pool. See 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.
Tapes	The container for information about all tapes.
Tape	The container for information about the tape containing the object.
AssignedToStorageDomain	Whether the tape is currently assigned to a storage domain. Values: TRUE, FALSE
AvailableRaw Capacity	The amount of unused raw capacity on the tape in bytes.
BarCode	The barcode on the label of the tape cartridge.
BucketId	The UUID for the bucket to which the tape is assigned.
DescriptionFor Identification	The LTFS Volume ID and name, if applicable. This is only provided if the BlackPearl gateway cannot identify the tape.
EjectDate	The date and time that the BlackPearl gateway discovered that the tape was ejected, in the format YYYY-MM-DDThh:mm:ss.xxxZ. If the parameter is empty, the tape has not been ejected.
EjectLabel	The user-entered information to assist in the handling of the tape.
EjectLocation	The user-entered information to describe where the ejected tape can be located.
EjectPending	The date and time that the tape was put in the queue to be ejected in the format YYYY-MM-DDThh:mm:ss.xxxZ. If the parameter is empty, the tape has not been queued to be ejected or the eject has started and is no longer cancelable.
FullOfData	Whether the tape is completely full of data. Values: TRUE, FALSE
Id	The UUID for the tape.
LastAccessed	The last date and time the tape was loaded into a tape drive in the format YYYY-MM-DDThh:mm:ss.xxxZ.
LastCheckpoint	An identifier, internal to the BlackPearl gateway, for verifying the application integrity of the tape.
LastModified	The last date and time the object was modified in the format YYYY-MM-DDThh:mm:ss.xxxZ. If this attribute is null, then the object has not yet been completely received into cache.
LastVerified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
PartitionId	The UUID for the partition to which the tape belongs.
PreviousState	The previous status of the tape. See State.
SerialNumber	The manufacturer-assigned serial number for the tape.
State	The status of the tape. See State.
StorageDomainId	The UUID for the storage domain to which the tape is assigned.
TakeOwnership Pending	Whether a tape from another BlackPearl gateway is waiting for ownership by the current gateway to be completed. Values: § TRUE — The foreign tape was imported when WriteProtected was TRUE, preventing the tape from being owned. § FALSE — The tape was imported successfully.
TotalRawCapacity	The total raw capacity of the tape in bytes.
Type	The tape format and generation of the tape cartridge. Values: LTO5, LTO6, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, UNKNOWN, FORBIDDEN
VerifyPending	The priority for the verify requested, or null if a verify has not been requested. The priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
WriteProtected	Whether the tape is write protected. Values: TRUE, FALSE
BlobsBeing Persisted	The number of blobs for the object currently being persisted to physical data stores.
BlobsDegraded	The number of blobs for the object in a degraded state.
BlobsInCache	The number of blobs for the object existing in cache.
BlobsTotal	The total number of blobs for the object.
BucketId	The UUID for the bucket in which the object resides.
CreationDate	The date and time the bucket was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
ETag	The http entity tag.
Id	The UUID for the object.
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Name	The name of the object.
Owner	The owner of the object.
Size	The size of the object in bytes.
Type	The type of object. Values: DATA, FOLDER
Version	The version number of the object.

Example

Sample Request

This request GETs information about all of the objects in all buckets with full details.

GET http://blackpearl-hostname/_rest_/object/?full_details
HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <Object>
      <BucketId>e980121b-d809-480e-90d3-04254e8ea7b2</BucketId>
      <CreationDate/>
      <ETag/>
      <Id>2373760e-fa82-4b76-9a04-e52b0199172f</Id>
      <Latest>TRUE</Latest>
      <Name>/audio/</Name>
      <Owner/>
      <Size>0</Size>
      <Type>FOLDER</Type><
      Version>1</Version>
   </Object>
   <Object>
      <BucketId>e980121b-d809-480e-90d3-04254e8ea7b2</BucketId>
      <CreationDate/>
      <ETag/>
      <Id>471054f9-7452-45e0-8ed1-2b7cb92ec6d0</Id>
      <Latest>TRUE</Latest>
      <Name>/cover.jpg</Name>
      <Owner>owner name</Owner>
      <Size>98789</Size>
      <Type>DATA</Type>
      <Version>1</Version>
   </Object>
</Data>