Spectra Logic

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

Get Tape

Description

Get information about the specified tape.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/tape/{tape UUID or barcode}/[?full_details]

To determine the UUID for a tape, see Get Tapes.

Request Parameters

Parameter	Description	Required
full_details	If included, information about the most recent failure and tasks assigned for the tape are included in the response.	no

Responses

Response Elements

<Data>
   <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>
   <MostRecentFailure> (only if full_details is included)
      <Date>{YYYY-MM-DDThh:mm:ss.xxxZ}</Date>

      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <TapeDriveId>{string}</TapeDriveId>
      <TapeId>{string}</TapeId>
      <Type>
         BAR_CODE_CHANGED|BAR_CODE_DUPLICATE|BLOB_READ_FAILED|
         DATA_CHECKPOINT_FAILURE|
         DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY|
         DATA_CHECKPOINT_MISSING|DELAYED_OWNERSHIP_FAILURE|
         DRIVE_CLEAN_FAILED|DRIVE_CLEANED|FORMAT_FAILED|
         GET_TAPE_INFORMATION_FAILED|IMPORT_FAILED|
         IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE|
         IMPORT_FAILED_DUE_TO_DATA_INTEGRITY|INSPECT_FAILED|
         READ_FAILED| REIMPORT_REQUIRED|SERIAL_NUMBER_MISMATCH|
         VERIFY_FAILED| WRITE_FAILED
      </Type>
   </MostRecentFailure>
   <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|INCOMPATIBLE|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|INCOMPATIBLE|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_JD|TS_JK|TS_JL|
      TS_JY|TS_JZ|TS_CLEANING_TAPE|UNKNOWN|FORBIDDEN
   </Type>

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

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
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 manufacturer-assigned 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.
MostRecentFailure	The container for information about the most recent failure, if applicable.
Date	The date and time of the inquiry in the format YYYY-MM-DDThh:mm:ss.xxxZ.
ErrorMessage	A description of the failure.
Id	The UUID for the error message.
TapeDriveId	The UUID for the tape drive.
TapeId	The UUID for the tape.
Type	The type of tape error message. Values: BAR_CODE_CHANGED, BAR_CODE_DUPLICATE, BLOB_READ_FAILED, DATA_CHECKPOINT_FAILURE, DATA_CHECKPOINT_FAILURE_DUE_TO_READ_ONLY, DATA_CHECKPOINT_MISSING, DELAYED_OWNERSHIP_FAILURE, DRIVE_CLEAN_FAILED, DRIVE_CLEANED, FORMAT_FAILED, GET_TAPE_INFORMATION_FAILED, IMPORT_FAILED, IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE, IMPORT_FAILED_DUE_TO_DATA_INTEGRITY, INSPECT_FAILED, READ_FAILED, REIMPORT_REQUIRED, SERIAL_NUMBER_MISMATCH, VERIFY_FAILED, WRITE_FAILED
PartitionId	The UUID for the partition to which to the tape belongs.
PreviousState	The previous status of the tape. See State.
SerialNumber	The manufacturer-assigned serial number for the tape cartridge.
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, LTO7, LTO_CLEANING_TAPE, TS_JC, TS_JD, TS_JK, TS_JL, TS_JY, TS_JZ, TS_CLEANING_TAPE, 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

Example

Sample Request

This request retrieves information about the tape with the UUID 0571b314-7f9d-4a9f-9e4b-98252c7b5266.

GET http://blackpearl-hostname/_rest_/tape/0571b314-7f9d-4a9f-9e4b-98252c7b5266/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <AssignedToStorageDomain>FALSE</AssignedToStorageDomain>
   <AvailableRawCapacity>10000</AvailableRawCapacity>
   <BarCode>018375L5</BarCode>
   <BucketId/>
   <DescriptionForIdentification/>
   <EjectDate/>
   <EjectLabel/>
   <EjectLocation/>
   <EjectPending/>
   <FullOfData>FALSE</FullOfData>
   <Id>0571b314-7f9d-4a9f-9e4b-98252c7b5266</Id>
   <LastAccessed/>
   <LastCheckpoint>
      83f811df-927b-4543-8dc8-8ca2ed002fcb:3
   </LastCheckpoint>
   <LastModified/>
   <LastVerified/>
   <PartitionId>26ef24cd-15f7-4aa0-aead-34abed82c60b</PartitionId>
   <PreviousState/>
   <SerialNumber/>
   <State>NORMAL</State>
   <StorageDomainId/>
   <TakeOwnershipPending>FALSE</TakeOwnershipPending>
   <TotalRawCapacity>1425000103936</TotalRawCapacity>
   <Type>LTO5</Type>
   <VerifyPending/>
   <WriteProtected>FALSE</WriteProtected>
</Data>