Spectra Logic

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

Get Suspect Objects with Full Details

Description

Get detailed information about all objects that the BlackPearl system suspects are degraded. Use parameters to get suspect object in one storage domain or one bucket.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/suspect_object​?full_details [&bucket_id={string}][&storage_domain_id={string}]

Request Parameters 

Parameter	Description	Required
full_details	Included to get a response that includes physical placement information.	yes
bucket_id a	The UUID, name, or other unique identifier for the bucket on which the job is operating.	no
storage_domain_id a	The UUID, name, or other unique attribute for the storage domain.	no

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

Responses

Response Elements

<Data>
   <Object Id="{string}" InCache="TRUE|FALSE" Latest="TRUE|FALSE"
      Length="{64‑bit integer}"Name="{string}

      "Offset="{64‑bit integer}" Version="{64‑bit integer}">
      <PhysicalPlacement>

         <AzureTargets>
            <AzureTarget>
               <AccountKey>{string}</AccountKey>

               <AccountName>{string}</AccountName>

               <AutoVerifyFrequencyInDays>
                 {integer}

               </AutoVerifyFrequencyInDays>

               <CloudBucketPrefix>{string}</CloudBucketPrefix>
               <CloudBucketSuffix>{string}</CloudBucketSuffix>
               <DefaultReadPreference>
                  MINIMUM_LATENCY|AFTER_ONLINE_POOL|
                  AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|
                  LAST_RESORT|NEVER
               </DefaultReadPreference>

               <Https>TRUE|FALSE</Https>
               <Id>{string}</Id>

               <LastFullyVerified/>
               <Name>{string}</Name>
               <PermitGoingOutOfSync>
                  TRUE|FALSE
               </PermitGoingOutOfSync>

               <Quiesced>NO|PENDING|YES</Quiesced>
               <State>ONLINE|OFFLINE|LIMITED_ACCESS</State>
            </AzureTarget>
            ...
         </AzureTargets>
         <Ds3Targets>
            <Ds3Target>
               <AccessControlReplication>
                  NONE|USERS
               </AccessControlReplication>
               <AdminAuthId>{string}</AdminAuthId>
               <AdminSecretKey>{string}</AdminSecretKey>
               <DataPathEndPoint>{string}</DataPathEndPoint>
               <DataPathHttps>TRUE|FALSE</DataPathHttps>
               <DataPathPort>{16-bit integer}</DataPathPort>

               <DataPathProxy>{string}</DataPathProxy>
               <DataPathVerifyCertificate>
                  TRUE|FALSE
               </DataPathVerifyCertificate>
               <DefaultReadPreference>
                  MINIMUM_LATENCY|AFTER_ONLINE_POOL|
                  AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|
                  LAST_RESORT|NEVER
               </DefaultReadPreference>
               <Id>{string}</Id>
               <Name>{string}</Name>

               <PermitGoingOutOfSync>
                  TRUE|FALSE
               </PermitGoingOutOfSync>
               <Quiesced>NO|PENDING|YES</Quiesced>

               <ReplicatedUserDefaultDataPolicy>
                  {string}
               </ReplicatedUserDefaultDataPolicy>

               <State>ONLINE|OFFLINE</State>
            </Ds3Target>
            ...
         </Ds3Targets>

         <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>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>

            ...
         </Pools>

         <S3Targets>
            <S3Target>
               <AccessKey>{string}</AccessKey>
               <AutoVerifyFrequencyInDays>
                  {integer}
               </AutoVerifyFrequencyInDays>

               <CloudBucketPrefix>{string}</CloudBucketPrefix>

               <CloudBucketSuffix>{string}</CloudBucketSuffix>

               <DataPathEndPoint>{string}</DataPathEndPoint>

               <DefaultReadPreference>
                  MINIMUM_LATENCY|AFTER_ONLINE_POOL|
                  AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|
                  LAST_RESORT|NEVER
               </DefaultReadPreference>

               <Https>TRUE|FALSE</Https>

               <Id>{string}</Id>

               <LastFullyVerified>{string}</LastFullyVerified>

               <Name>{string}</Name>

               <OfflineDataStagingWindowInTb>

                  {64-bit integer}

               </OfflineDataStagingWindowInTb>

               <PermitGoingOutOfSync>
                  TRUE|FALSE
               </PermitGoingOutOfSync>

               <ProxyDomain>{string}</ProxyDomain>

               <ProxyHost>{string}</ProxyHost>

               <ProxyPassword>{string}</ProxyPassword>

               <ProxyPort>{64-bit integer}</ProxyPort>

               <ProxyUsername>{string}</ProxyUsername>

               <Quiesced>NO|PENDING|YES</Quiesced>

               <Region>{string}</Region>

               <SecretKey>{string}</SecretKey>

               <StagedDataExpirationInDays>

                  {64-bit integer}

               </StagedDataExpirationInDays>

               <State>ONLINE|OFFLINE|LIMITED_ACCESS</State>

            </S3Target>

            ...

         </S3Targets>

 

         <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>

               <PartiallyVerifiedEndOfTape>
                  {YYYY-MM-DDThh:mm:ss.xxxZ}
               </PartiallyVerifiedEndOfTape>
               <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|INSPECTION_PENDING|LOST|
                  LTFS_WITH_FOREIGN_DATA|OFFLINE|
                  ONLINE_IN_PROGRESS|ONLINE_PENDING|
                  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|INSPECTION_PENDING|LOST|
                  LTFS_WITH_FOREIGN_DATA|OFFLINE|
                  ONLINE_IN_PROGRESS|ONLINE_PENDING|
                  SERIAL_NUMBER_MISMATCH|UNKNOWN
               </State>

               <StorageDomainId>{string}</StorageDomainId>

               <TakeOwnershipPending>
                  TRUE|FALSE
               </TakeOwnershipPending>

               <TotalRawCapacity>
                  {64‑bit integer}
               </TotalRawCapacity>
               <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
               </Type>
               <VerifyPending>
                  CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
               </VerifyPending>
               <WriteProtected>TRUE|FALSE</WriteProtected>
            </Tape>
            ...
         </Tapes>
      </PhysicalPlacement>
   </Object>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
Object	The container for information about one object.
Id	The UUID for the Object
InCache	Whether the object is currently in cache. Values: TRUE, FALSE
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Length	The length in bytes of the object.
Name	The name of the object.
Offset	The offset in bytes from the start of the object.
Version	The version number of the object.
PhysicalPlacement	The container for the list of storage types containing the object.
AzureTargets	The container for information about all Azure targets with degraded objects.
AzureTarget	The container for information about one Azure target with a degraded object.
AccountName	The account name for the Microsoft Azure account. Note: You can not use the same Account Name for multiple Microsoft Azure targets.
AutoVerify FrequencyInDays	The frequency at which a full verify of the data on the target is scheduled. If null, no full verify is scheduled.
CloudBucketPrefix	The Azure target bucket prefix. The system adds the prefix to the BlackPearl bucket name when it replicates the bucket to the Azure target.
CloudBucketSuffix	The Azure target bucket suffix. The system adds the suffix to the BlackPearl bucket name when it replicates the bucket to the Azure target.
DefaultRead Preference	When it is preferable to read from the Azure target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
Https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE.
Id	The UUID for the Azure target instance.
LastFullyVerified	The date and time the target was last fully verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the Azure target.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated fopr Azure targets.
Quiesced	Whether the Azure target is in a temporarily inactive state. Values: NO, PENDING, YES
State	The state of the Azure target. Values: ONLINE, OFFLINE, LIMITED_ACCESS
Ds3Targets	The container for information about all BlackPearl targets with degraded objects.
Ds3Target	The container for information about one BlackPearl target with a degraded object.
AccessControl Replication	The access control that is replicated to the BlackPearl target. Values: § NONE — No access control is replicated. § USERS — The source BlackPearl system replicates its users and passwords to the target system.
AdminAuthId	The S3 access ID assigned to an Administrator.
AdminSecretKey	The S3 secret key for the account matching the given AdminAuthId.
DataPathEndPoint	The IPv4 address or DNS name for the data path of the BlackPearl target.
DataPathHttps	Whether the source BlackPearl system uses the HTTPS protocol to setup and replicate data to the target system. Values: TRUE, FALSE
DataPathPort	The value of the port on which the target BlackPearl system’s S3 server is running. If null, the parameter defaults to port 80 for HTTP connections and port 443 for HTTPS connections.
DataPathProxy	The proxy server for the source BlackPearl system to use to connect to the target system.
DataPathVerify Certificate	Whether the data path certificate is verified. When DataPathVerifyCertificate and DataPathHttps are both TRUE, the source BlackPearl system fully validates the target system’s certificate. If the certificate is not trusted or problematic in anyway, it is not honored. Values: TRUE, FALSE
DefaultRead Preference	When it is preferable to read from the BlackPearl target rather than the replication source. Only use the MINIMUM_LATENCY read preference when the network between the source and target is very inexpensive. In this mode, the source BlackPearl system dynamically determines the read preference based on whether the requested data resides in a pool or on tape. For example, if the replication source has the data in a pool, the system reads the data from the local pool. If however, the replication source only has the data on tape and the BlackPearl target has the data in a pool, the data is read from the target pool. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER
Id	The UUID for the BlackPearl target instance. Note: If a BlackPearl target has its instance identifier reset after it is registered on other BlackPearl systems, the replication link is forever invalid and must be deleted and re-created.
Name	The name for the BlackPearl target.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. By default, if the data policy specifies that the BlackPearl system must replicate local actions, actions that the system cannot replicate fail. You can temporarily set this parameter to TRUE in order to operate in full capacity locally while one or more targets is down for a prolonged period of time.
Quiesced	Whether the BlackPearl target is in a temporarily inactive state. Values: NO, PENDING, YES
ReplicatedUser DefaultDataPolicy	The data policy the target applies as the default data policy for any users replicated to the target.
State	The state of the BlackPearl target. Values: ONLINE, OFFLINE, LIMITED_ACCESS
Pools	The container for information about all storage pools with degraded objects.
Pool	The container for information about one storage pool with a degraded object.
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 the object 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. 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.
S3Targets	The container for information about all Amazon S3 targets with degraded objects.
S3Target	The container for information about one Amazon S3 target with a degraded object.
AccessKey	The the S3 Access Key of the user for the Amazon S3 account.
AutoVerify FrequencyInDays	The frequency at which a full verify of the data on the target is scheduled. If null, no full verify is scheduled.
CloudBucketPrefix	The Amazon S3 target bucket prefix. The system adds the prefix to the BlackPearl bucket name when it replicates the bucket to the Amazon S3 target.
CloudBucketSuffix	The Amazon S3 target bucket suffix. The system adds the suffix to the BlackPearl bucket name when it replicates the bucket to the Amazon S3 target.
DataPathEndpoint	The IPv4 address or DNS name for the data path of the AWS cloud service.
DefaultRead Preference	When it is preferable to read from the Amazon S3 target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
Https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE.
Id	The UUID for the Amazon S3 target instance.
LastFullyVerified	The date and time data on the target was last fully verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the Amazon S3 target.
OfflineDataStagingWindowInTb	The maximum size, in TB, of the window available for staging data that is offline (in Glacier) so that it can be read.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated for S3 targets.
ProxyDomain	The domain name for the proxy server.
ProxyHost	The host name or IP address for the proxy server to which the BlackPearl system connects.
ProxyPassword	The password used when connecting through the proxy server.
ProxyPort	The proxy server port through which the BlackPearl system connects.
ProxyUsername	The username used when connecting through the proxy server.
Quiesced	Whether the Amazon S3 target is in a temporarily inactive state. Values: NO, PENDING, YES
Region	The world region where the Amazon S3 target is physically located. Values: US_EAST_1, US_WEST_1, US_WEST_2, EU_WEST_1, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, GOV_CLOUD
SecretKey	The secret key associated with the AccessKey.
StagedData ExpirationInDays	The number of days before the pre‐staged copy of data can expire.
State	The state of the Amazon S3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS
Tapes	The container for information about all tapes with degraded objects.
Tape	The container for information about the tape containing the degraded 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 system cannot identify the tape.
EjectDate	The date and time that the BlackPearl system 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 system, 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.
LastVerified	The last date and time the checksum of the data was verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
PartiallyVerified EndOfTape	The last date and time the BlackPearl system verfied the data on a specified percentage of the tape capacity before the EOD marker 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 system is waiting for the current system to complete taking ownership. Values: § TRUE — The foreign tape was imported when WriteProtected was TRUE, preventing the tape from being claimed by the current system. § 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, LTO8, LTOM8, LTO_CLEANING_TAPE, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, 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 gets information about all suspect objects.

GET http[s]://blackpearl-hostname/_rest_/suspect_object/?full_details HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <Object Bucket="bucket2"
      Id="def4e5f7-f0f7-44b7-9a48-0e0710935071" InCache="false"
      Latest="true" Length="10" Name="object2" Offset="0"
      Version="1">
      <PhysicalPlacement>
         <AzureTargets/>
         <Ds3Targets/>
         <Pools/>
         <S3Targets/>

         <Tapes>
            <Tape>
               <AssignedToStorageDomain>
                  false
               </AssignedToStorageDomain>
               <AvailableRawCapacity>10000</AvailableRawCapacity>
               <BarCode>
                  d5a78a1f-4ffc-43d1-b302-a565d266d8a3
               </BarCode>
               <BucketId/>
               <DescriptionForIdentification/>
               <EjectDate/>
               <EjectLabel/>
               <EjectLocation/>
               <EjectPending/>
               <FullOfData>false</FullOfData>
               <Id>c50e8f13-21fe-48e5-b922-3ce4aca94017</Id>
               <LastAccessed/>
               <LastCheckpoint/>
               <LastModified/>
               <LastVerified/>
               <PartiallyVerifiedEndOfTape/>
               <PartitionId>
                  4a72d5ad-a5b3-431d-8cdf-282c77620f53
               </PartitionId>

               <PreviousState/>
               <SerialNumber/>
               <State>INSPECTION_PENDING</State>
               <StorageDomainId>
                  78620692-8a4c-4c80-bfb6-02c47eced40d
               </StorageDomainId>
               <TakeOwnershipPending>false</TakeOwnershipPending>
               <TotalRawCapacity>20000</TotalRawCapacity>
               <Type>LTO5</Type>
               <VerifyPending/>
               <WriteProtected>false</WriteProtected>
            </Tape>
         </Tapes>
      </PhysicalPlacement>
   </Object>
</Data>

<Data>